generated from jhudsl/OTTR_Template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update student guide so there is a direct option for cloning a workspace
- Loading branch information
1 parent
ac61284
commit a7d8ada
Showing
2 changed files
with
67 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,32 @@ | ||
In order to run your analyses, you will use the [AnVIL cloud computing platform](https://anvilproject.org/), so that you do not need to install everything on your own computer. The AnVIL (Analysis Visualization and Informatics Lab-space) platform is specially designed for analyzing biological data, and is used by scientists doing all sorts of biological research. | ||
In order to run your analyses, you will use the [AnVIL cloud computing platform](https://anvilproject.org/). The AnVIL (Analysis Visualization and Informatics Lab-space) platform is specially designed for analyzing biological data, and is used by scientists doing all sorts of biological research. | ||
|
||
:::{.notice} | ||
**AnVIL in a nutshell** | ||
|
||
- Behind the scenes, AnVIL relies on Google Cloud Platform to provide computing infrastructure. Basically, AnVIL lets you "rent" computers from Google (remotely). Whenever you run an analyses on AnVIL, it actually runs on one of Google's computers, and AnVIL lets you see the results in your browser. | ||
- AnVIL uses [Terra](https://anvil.terra.bio/) to provide many computational tools useful for biological data analysis, such as [RStudio](https://www.rstudio.com/products/rstudio/), [Galaxy](https://usegalaxy.org/), and [Jupyter Notebooks](https://jupyter.org/). Terra takes care of installing these tools on Google's computers, so that you can just start using them. | ||
- Behind the scenes, AnVIL relies on Google Cloud Platform to provide computing infrastructure. Basically, AnVIL lets you "rent" computers through the internet. The analysis is run on the rented computer. AnVIL lets you see the results in your browser. | ||
- AnVIL uses [Terra](https://anvil.terra.bio/) to provide many computational tools useful for biological data analysis, such as [RStudio](https://www.rstudio.com/products/rstudio/), [Galaxy](https://usegalaxy.org/), and [Jupyter Notebooks](https://jupyter.org/). Terra takes care of installing these tools so you can use them right away. | ||
::: | ||
|
||
### Create Google Account | ||
|
||
First, you will need to set up a (free) Google account. | ||
|
||
If you do not already have a Google account that you would like to use for accessing AnVIL, [create one now](https://accounts.google.com/SignUp). | ||
A Google account usually looks like "`[email protected]`". Alternatively, you can enable Google for an existing non-Gmail email address using [these instructions](https://support.terra.bio/hc/en-us/articles/360029186611). | ||
|
||
- Alternatively, if you would like to create a Google account that is associated with an existing non-Gmail email address, you can follow [these instructions](https://support.terra.bio/hc/en-us/articles/360029186611). | ||
If you do not already have a Google account that you would like to use for accessing AnVIL, [create one now](https://accounts.google.com/SignUp). | ||
|
||
### Log In to Terra | ||
|
||
Next, make sure you can log in to Terra -- you will use Terra to perform computations on AnVIL. | ||
|
||
You can access Terra by going to [`anvil.terra.bio`](https://anvil.terra.bio/), or by clicking the link on the [AnVIL home page](https://anvilproject.org/). | ||
|
||
|
||
```{r, echo=FALSE, fig.alt='Screenshot of the AnVIL home page. The section descring Terra is highlighted.'} | ||
ottrpal::include_slide("https://docs.google.com/presentation/d/1-PVlDAzmDncjcCHIy9ZyR3ROyPpfjrg46LhEQopDc1Q/edit#slide=id.g22c9add987a_0_5") | ||
``` | ||
|
||
Open Terra, and you should be prompted to sign in with your Google account. | ||
You can access Terra by going to [`anvil.terra.bio`](https://anvil.terra.bio/). Open Terra, and you should be prompted to sign in with your Google account. | ||
|
||
### Share Username | ||
|
||
Finally, make sure your instructor has your Google account username (e.g. `[email protected]`), so they can give you access to everything you need. | ||
Make sure your instructor has your Google account username (e.g. `[email protected]`), so they can give you access to everything you need. | ||
|
||
- Make sure there are no typos! | ||
- If you have multiple Google accounts, make sure you give them the username that you will be using to access AnVIL | ||
- If you have multiple Google accounts, make sure you give them the username that you will be using to log in to `anvil.terra.bio`. | ||
|
||
:::{.warning} | ||
It is *very important* that you share the Google account you will be using to access AnVIL with with your instructor! Otherwise, the instructor cannot add you to Billing Projects or Workspaces, and you will be unable to proceed with your assignments. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
```{r, include = FALSE} | ||
if (!exists("AnVIL_module_settings")) { | ||
AnVIL_module_settings <- list() | ||
} | ||
if (is.null(AnVIL_module_settings$workspace_name)) { | ||
AnVIL_module_settings$workspace_name = "specified by your instructor" | ||
AnVIL_module_settings$clone_name = "ExampleWorkspace_Firstname_Lastname" | ||
} else { | ||
AnVIL_module_settings$clone_name = paste0(AnVIL_module_settings$workspace_name, "_Firstname_Lastname") | ||
} | ||
if (is.null(AnVIL_module_settings$workspace_link)) { | ||
AnVIL_module_settings$workspace_link = "ask your instructor" | ||
} | ||
if (is.null(AnVIL_module_settings$billing_project)) { | ||
AnVIL_module_settings$billing_project = "provided by your instructor" | ||
} | ||
``` | ||
|
||
:::{.warning} | ||
This **will not work** until your instructor has given you permission to spend money to "rent" the computers that will power your analyses (by adding you to a "Billing Project"). | ||
::: | ||
|
||
On AnVIL, you access files and computers through **Workspaces**. Each Workspace functions almost like a mini code laboratory - it is a place where data can be examined, stored, and analyzed. The first thing we want to do is to copy or “clone” a Workspace to create a space for you to experiment. This will give you access to | ||
|
||
- the files you will need (data, code) | ||
- the computing environment you will use | ||
|
||
:::{.notice} | ||
**Tip** | ||
At this point, it might make things easier to open up a new window in your browser and split your screen. That way, you can follow along with this guide on one side and execute the steps on the other. | ||
::: | ||
|
||
To clone an AnVIL Workspace: | ||
|
||
1. Go to the Workspace by clicking this link: `r AnVIL_module_settings$workspace_link`. | ||
|
||
1. Clone the workspace by clicking the teardrop button (![teardrop button](https://raw.githubusercontent.com/jhudsl/AnVIL_Template/main/child/child_assets/teardrop_button.png){width=25px}). Select "Clone". See the screenshot below on a different Workspace: | ||
|
||
```{r, echo=FALSE, out.width = '100%', fig.alt='Screenshot showing the teardrop button. The button has been clicked revealing the "clone" option. The Clone option and the teardrop button are highlighted.'} | ||
ottrpal::include_slide("https://docs.google.com/presentation/d/1a5Da6qX9BG7Q_6XAz7MvlDyWTvssm2hWwuo1WFJXb_0/edit#slide=id.g117abafa453_0_577") | ||
``` | ||
1. You will see a popup box appear, asking you to configure your Workspace | ||
a. Give your Workspace clone a name by adding an underscore ("_") and your name. For example, \"`r AnVIL_module_settings$clone_name`\". | ||
a. Select the Billing Project `r AnVIL_module_settings$billing_project`. | ||
a. Leave the bottom two boxes as-is. | ||
a. Click “CLONE WORKSPACE”. | ||
See the screenshot below on a different Workspace: | ||
```{r, echo=FALSE, out.width = '100%', fig.alt='Screenshot showing the "clone a workspace" popout. The Workspace name, Billing Project, and Clone Workspace button have been filled in and highlighted.'} | ||
ottrpal::include_slide("https://docs.google.com/presentation/d/1a5Da6qX9BG7Q_6XAz7MvlDyWTvssm2hWwuo1WFJXb_0/edit#slide=id.g17144dbacd0_0_352") | ||
``` | ||
1. The new Workspace should now show up under https://anvil.terra.bio/#workspaces. This is your own copy of the Workspace to work in. | ||
```{r, include = FALSE} | ||
AnVIL_module_settings <<- NULL | ||
``` |