Skip to content

Commit 9dafbfe

Browse files
authored
Merge pull request #106 from jhudsl/student-guide-updates
update student-guide
2 parents 291642e + f57d459 commit 9dafbfe

File tree

8 files changed

+27
-64
lines changed

8 files changed

+27
-64
lines changed

99-student_guide.Rmd

Lines changed: 0 additions & 10 deletions
This file was deleted.

References.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
# References

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/99-student_guide.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

student-guide/Student_Guide.docx

-11.2 KB
Binary file not shown.

student-guide/_bookdown.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
book_filename: "Student_Guide"
21
chapter_name: "Chapter "
32
repo: https://github.com/jhudsl/AnVIL_Book_Instructor_Guide/
43
rmd_files: ["index.Rmd",
5-
"99-student_guide.Rmd"]
4+
"student-guide.Rmd",
5+
"About.Rmd",
6+
"References.Rmd"]
67
new_session: yes
78
bibliography: [book.bib]
89
delete_merged_file: true
910
language:
1011
ui:
1112
chapter_name: "Chapter"
12-
output_dir: "student-guide"
13+
book_filename: "Student_Guide" # Do not change
14+
output_dir: "student-guide/docs" # Do not change

student-guide/index.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

student-guide/reference-keys.txt

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)