2.3 Project Documentation

There are two project-level documentation files that you will need to create and keep updated throughout the semester.

2.3.1 README.md

You will need a read-me file in the top-level of your assignment repository. You can create it in RStudio (File > New File > Text File). This file should describe the goal of the repository and, at a high level, how various elements of the project repository fit together. This file should be saved as a markdown file (.md) and should use markdown formatting appropriately.

2.3.2 RESEARCH_LOG.md

You will need to maintain a research log throughout the final project process. Before proceeding with the vignettes, create a well-formatted and organized research log in RStudio (File > New File > Text File) that is organized chronologically. The research log should use markdown syntax and be saved as a markdown file (.md). Keep this file updated and have it saved in the top-level of your assignment repository.

For each day you work on the final project, there should be an entry that describes the work that you have done, what files you have created or modified, and how those modifications took place. Give as much detail as possible without directly replicating the notes you make in individual files using the literate programming approach.

Think of the research log as step-by-step instructions to yourself that would allow you to recreate all of your work should every final project file you work on be accidentally deleted or lost. For code, you can provide higher level details since, ideally, your literate programming approach means that your code is well annotated and described. For plots and your slides, you want to provide as much fine grained detail as possible down to specific font, color, and size choices for data and layout elements.