Instructor Notes
This is a placeholder file. Please add content here.
Before we start
Introduction
Instructor Note
The questions above are self-assessment questions to let the participants hear and report back on their or others’ practices. This motivates a self-evaluation to include or replace previous practices, and potentially leave the session aware or motivated to proceed differently in the next iteration.
Research compendium
Git with Rstudio reminder
- From the “Review changes” pane:
- Go to the “History” tab in the top left.
- Show that each commit has an ID under the SHA/hash column
- Go to GitHub:
- Identify where this ID, called SHA/hash, is located.
Reproducible analysis
README files
Instructor Note
The usethis package provides control of flow
functionality to commit the README.md only when
synchronised with README.Rmd. We have yet to test that
behaviour.
Instructor Note
Contributing guides and Function documentation are also visible in a website format. Please look at the Appendix episode to learn how to do it.
Wrap up
Appendix
Instructor Note
If required, you can add vignettes for an rcompendium using:
R
rcompendium::add_vignette(filename = "vignette-01")
Vignettes look more suitable for package documentation than a project. But knowing that we have that alternative with the rcompendium template is helpful.
Instructor Note
This manuscript will not be visible on a website unless moved to the
vignette/ folder. We have yet to test that behaviour.