Setting up a project with prodigenr
Starting a research project? Create a project directory like so:
library(prodigenr)
# Create a temporary folder using the fs package
new_project_path <- fs::path_temp("HeartDiseaseExercise")
setup_project(new_project_path)Or via RStudio’s interface (with RStudio version >1.1):
Creating a prodigenr project in RStudio
The resulting file structure should look something like this:
HeartDiseaseExercise
├── DESCRIPTION
├── HeartDiseaseExercise.Rproj
├── R
│ └── README.md
├── README.md
├── TODO.md
├── data
│ └── README.md
├── data-raw
│ └── README.md
└── doc
├── README.md
└── report.RmdREADME.md files are contained within each project and in
each folder that explains a bit more about what each folder and file are
used for, which is briefly described here:
R/: Should contain the R scripts and functions used for the analysis.doc/: Should contain the files related to presenting the project’s scientific output. Already has the report/manuscript inside.data/: If relevant, is where the processed (or simulated) data is kept that is used for the project as well as the results of the project’s analyses.data-raw/: If relevant, is where the scripts that process the raw data into the usable data are kept and, optionally where the raw data is also kept.DESCRIPTION: Is a standard file that includes metadata about your project, in a machine readable format, and that also stores a list of the R packages your project depends on..Rproj: Is a standard file used by RStudio to set some R Project specific settings.
To add a new document (e.g. slides, manuscript), run any of the
create_*() commands (e.g. create_slides()) in
the console while in RStudio in the newly created project (via the
.Rproj file):
# you need to run these in the project's console
create_slides()#> ✔ Creating a "slides" file in the "doc/" folder.Now two more files have been added to the doc/ folder.
The resulting file structure should look something like this:
HeartDiseaseExercise
├── DESCRIPTION
├── HeartDiseaseExercise.Rproj
├── R
│ └── README.md
├── README.md
├── TODO.md
├── data
│ └── README.md
├── data-raw
│ └── README.md
└── doc
├── README.md
├── report.Rmd
└── slides.RmdAt present, there are only two template files that you can view:
template_list
#> [1] "report" "slides"These template files are what an academic researcher likely typically encounters. However, if you have a suggestion or want to add a template, please create a Github issue or submit a Pull Request!
The end goal of each project is to be as self contained as possible. So that if you ever need to go back to the analysis, it is easy to re-run the code and get the results that you say you got. This is especially useful if others such as reviewers ask for something or want to confirm your results. See the manifesto for more details on the underlying philosophy behind this package.