This README details how this slide directory is structured, how files should be run and what the different files do.
The files were created by the
prodigenr package and use
the following programs:
- GNU Make (automating executing file scripts)
- Pandoc (for Markdown (
- R (stats)
- Package: knitr (reproducibility)
- Git (version control system)
- Shell script (e.g. Bash; to use most of the above programs)
Directory structure and explanation
The project directory is generally structured with
folders, as well as a version control
.git folder. As a caveat,
there may be folders other than the below that were created for an ad
hoc purpose. The Makefile contains the commands to create the slides,
make in the terminal to see a list of options.
data folder contains the analysis-specific dataset. Meaning
this dataset may be a subset of an original dataset, keeping the data
relevant to the research question.
src folder contains the R commands and scripts used by all
subsequent scripts and R Markdown files. There are at least three
fetchData.R to get, process, and save a dataset;
load libraries and run options for packages; and,
hold all custom functions used for the analysis.