generated from jhudsl/OTTR_Template
-
Notifications
You must be signed in to change notification settings - Fork 1
/
08-student_modules.Rmd
141 lines (109 loc) · 4.42 KB
/
08-student_modules.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
```{r echo = FALSE}
knitr::opts_chunk$set(out.width = "100%")
```
# Student instructions
Modules aimed at students in a course or workshop.
<br>
## Student Account Setup
:::: {.borrowed_chunk}
```{r, echo = FALSE, results='asis'}
cow::borrow_chapter(
doc_path = "child/_child_student_create_account.Rmd",
repo_name = "jhudsl/AnVIL_Template"
)
```
::::
## Student instructions for cloning a Workspace
These instructions can be customized to a specific workspace by setting certain variables before running `cow::borrow_chapter()`. If these variables have not been set, reasonable defaults are provided (e.g. "ask your instructor").
### With no variables set:
:::: {.borrowed_chunk}
```{r, echo = FALSE, results='asis'}
cow::borrow_chapter(
doc_path = "child/_child_student_workspace_clone.Rmd",
repo_name = "jhudsl/AnVIL_Template"
)
```
::::
### With variables set:
:::: {.borrowed_chunk}
```{r, echo = FALSE, results='asis'}
# Specify variables
AnVIL_module_settings <- list(
workspace_name = "Example_Workspace",
workspace_link = "http://example.com/",
billing_project = "Example Billing Project"
)
cow::borrow_chapter(
doc_path = "child/_child_student_workspace_clone.Rmd",
repo_name = "jhudsl/AnVIL_Template"
)
```
::::
## Student instructions for launching Jupyter
The module below is specially customized for students, allowing you to give more specific instructions on the settings for their Jupyter environment. There are several other general purpose modules that may also be useful for students (e.g. Pausing Jupyter, Deleting Jupyter) that can be found in other chapters of this book.
The following instructions can be customized by setting certain variables before running `cow::borrow_chapter()`. Developers should create these variables as a list `AnVIL_module_settings`. The following variables can be provided:
- `audience` = Defaults to `general`, telling them to use the default Jupyter settings. If `audience` is set to `student`, it gives more specific instructions.
- `docker_image` = Optional, it will tell them how to set the image.
- `startup_script` = Optional, it will tell them how to set the script.
### Using default Jupyter environment:
:::: {.borrowed_chunk}
```{r, echo = FALSE, results='asis'}
# Specify variables
AnVIL_module_settings <- list(
audience = "student"
)
cow::borrow_chapter(
doc_path = "child/_child_jupyter_launch.Rmd",
repo_name = "jhudsl/AnVIL_Template"
)
```
::::
### Using custom Jupyter environment:
:::: {.borrowed_chunk}
```{r, echo = FALSE, results='asis'}
# Specify variables
AnVIL_module_settings <- list(
audience = "student",
docker_image = "example docker",
startup_script = "example startup script"
)
cow::borrow_chapter(
doc_path = "child/_child_jupyter_launch.Rmd",
repo_name = "jhudsl/AnVIL_Template"
)
```
::::
## Student instructions for launching RStudio
The module below is specially customized for students, allowing you to give more specific instructions on the settings for their RStudio environment. There are several other general purpose modules that may also be useful for students (e.g. Pausing RStudio, Deleting RStudio) that can be found in other chapters of this book.
The following instructions can be customized by setting certain variables before running `cow::borrow_chapter()`. Developers should create these variables as a list `AnVIL_module_settings`. The following variables can be provided:
- `audience` = Defaults to `general`, telling them to use the default RStudio settings. If `audience` is set to `student`, it gives more specific instructions.
- `docker_image` = Optional, it will tell them to open the customization dialogue and direct them on how to set the image.
- `startup_script` = Optional, it will tell them to open the customization dialogue and direct them on how to set the script.
### Using default RStudio environment:
:::: {.borrowed_chunk}
```{r, echo = FALSE, results='asis'}
# Specify variables
AnVIL_module_settings <- list(
audience = "student"
)
cow::borrow_chapter(
doc_path = "child/_child_rstudio_launch.Rmd",
repo_name = "jhudsl/AnVIL_Template"
)
```
::::
### Using custom RStudio environment:
:::: {.borrowed_chunk}
```{r, echo = FALSE, results='asis'}
# Specify variables
AnVIL_module_settings <- list(
audience = "student",
docker_image = "example docker",
startup_script = "example startup script"
)
cow::borrow_chapter(
doc_path = "child/_child_rstudio_launch.Rmd",
repo_name = "jhudsl/AnVIL_Template"
)
```
::::