Repository files navigation

This repository is supposed to mimic a research project containing an analysis, simulation, and report written in RMarkdown. I also include the presentation slides from the workshop held on 11/19/2021.

There are three key takeaways that this repository is hoping to showcase:

1. Annotation: All of the code files (exceptanalysis/analysis_UGLY.R) are commented and structured according to the advice given in the workshop.
2. Organization: The whole repository tries to follow the advice as well.
3. Replicability: Finally, by includingrenv into the project, I also hope to show how easy it is to reproduce the project environment with very little space/time.

• Theanalysis folder contains the clean-codedanalysis.R and exemplary ugly-codedanalysis_UGLY.R files, which run a linear regression of the simulated data and save a regression table and predicted value plots for the report.
• Thedata folder contains the.csv simulated data.
• Thereport folder contains all the figures, tables, and.Rmd report file, compiling them together into a final PDF.
• Thesimulation folder contains a.R script that creates the simulated data used in the analysis.
• Therenv folder and related files ought not to be modified and are included for replicability purposes. To see howrenv works check outIntroduction to renv.
• ThePML_presentation folder is not part of the example and contains the presentation slides from the workshop.