Skip to content

Commit 1a41114

Browse files
committed
update student-guide config and add student-guide.Rmd
1 parent 1c1e1c7 commit 1a41114

File tree

4 files changed

+29
-4
lines changed

4 files changed

+29
-4
lines changed

resources/dictionary.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ deconvolved
2222
der
2323
differentially
2424
dimensionality
25+
docx
2526
doi
2627
downregulated
2728
downregulation
@@ -78,6 +79,7 @@ PMC
7879
preprint
7980
QC
8081
Res
82+
Rmd
8183
RNA
8284
RNA-seq
8385
scanpy

student-guide.Rmd

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
# Student Guide
3+
4+
## Activity One
5+
6+
Many of the AnVIL books that are designed for teaching a class or workshop contain information aimed at the instructor.
7+
8+
You might want to create a "student guide" that contains a different subset of Rmd files from your book, or renders to a different output format (e.g. word document). You can specify the output and Rmd files that will be used for the student guide using the `_output.yml` and `_bookdown.yml` files in the `student-guide` directory.
9+
10+
By default, repositories based on `AnVIL_Template` create a docx file containing this chapter as an example. Once you have adjusted `student-guide/bookdown.yml` to include the chapters you want in your student guide, you can link to it by replacing `{repo-name}` in the following URL:
11+
12+
`https://github.com/jhudsl/{repo-name}/raw/main/student-guide/docs/Student_Guide.docx`
13+
14+
When someone clicks this link, they will download the docx file. For example, here is the link for the student guide from `AnVIL_Template`:
15+
16+
https://github.com/jhudsl/AnVIL_Template/raw/main/student-guide/docs/Student_Guide.docx
17+
18+
## Activity Two
19+
20+
Steps of the guide could go here.

student-guide/_bookdown.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
book_filename: "Student_Guide"
21
chapter_name: "Chapter "
3-
repo: https://github.com/jhudsl/AnVIL_Template/
2+
repo: https://github.com/jhudsl/GDSCN_Book_Statistics_for_Genomics_scRNA-seq/
43
rmd_files: ["index.Rmd",
5-
"09-student_guide.Rmd",
4+
"student-guide.Rmd",
5+
"About.Rmd",
66
"References.Rmd"]
77
new_session: yes
88
bibliography: [book.bib]
99
delete_merged_file: true
1010
language:
1111
ui:
1212
chapter_name: "Chapter"
13-
output_dir: "student-guide"
13+
book_filename: "Student_Guide" # Do not change
14+
output_dir: "student-guide/docs" # Do not change

student-guide/_output.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
bookdown::word_document2:
2+
toc: true

0 commit comments

Comments
 (0)