Introduction to prodigenr

Luke W. Johnston

2019-07-01

Are you an academic researcher who often writes up abstracts for conferences or submits manuscripts to journals? Do you often have to make slides or posters for presentations? Is your usual workflow to copy a previous project and start replacing the old text for the new text? This R package was designed with you in mind!

prodigenr, or project directory generator, simplifies the process of creating these new projects and can help make your workflow more reproducible. Standard files and folders are created for specific projects (e.g. abstracts or manuscripts), along with a workflow that tries to be simple and easy to use, while making use of the infrastructure and processes already well-developed and maintained (e.g. RStudio and devtools).

Because researchers often write or create many papers, slides, posters, and abstracts, it can quickly become tedious and messy to always make a new directory with all the necessary files and organization.

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)
#> ✔ Created project at '/tmp/Rtmp4QZTUE/HeartDiseaseExercise'
#> ✔ Added 'README.md' files to the 'doc/', 'R/', 'data/', and parent folders
#> ✔ Added some template R scripts to the 'R/' folder
#> ✔ Project placed under Git version control
#> ✔ Project setup has been completed!
#> ● Now open 'HeartDiseaseExercise.Rproj' to get started on the project!

Or via RStudio’s interface (with RStudio version >1.1):