Class materials
Session |
Lecture slides |
Interactive session |
Reflection |
|---|---|---|---|
| Morning | Command line and remote server | Navigate the server | Server vs local |
| Afternoon | Documentation | READMEs, style, and comments | Course support |
Further reading
Marwick, Boettiger, and Mullen (2018) describe a system for creating a research compendium (a single archive of data, code, results, and manuscript) using R. They provide multiple examples of how to document code and data.
Salmon (2023) digs deeper into what does (and doesn’t) make for a good comment.
References
Marwick, Ben, Carl Boettiger, and Lincoln Mullen. 2018. “Packaging Data Analytical Work Reproducibly Using R (and Friends).” The American Statistician 72 (1): 80–88. https://doi.org/10.1080/00031305.2017.1375986.
Salmon, Maëlle. 2023. “Why Comment Your Code as Little (and as Well) as Possible.” R-Hub.io. https://blog.r-hub.io/2023/01/26/code-comments-self-explaining-code/. https://blog.r-hub.io/2023/01/26/code-comments-self-explaining-code/.