This R package is part of a series of (planned) packages that are aimed at creating a toolkit for doing reproducible and open science. Many researchers (especially in biomedicine, medicine, or health, which is my area of research) have little to no knowledge on what open science is or what reproducibility is, let alone how to do it. Our goal is create an (opinionated) toolkit to automate and simplify the process of doing open and reproducible science.
This specific package is a project directory generator (prodigenr). It will create a standardized project folder structure with the necessary template files for managing and analyzing data and for creating common scientific output (e.g. manuscripts). Because of the standardized structure and because of the focus on a “one project, one scientific output”, this allows the final code and documents to be fairly modular, self-contained, easy to share and make public… and be as reproducible as possible. This folder structure also makes use of the existing and established applications and workflows (RStudio, devtools, and usethis). This package aims to make it easier to adhere to open scientific practices by following a standard, consistent, and established folder and file structure for data analysis projects.
You can install the released version of prodigenr from CRAN with:
And the development version from GitHub with:
# install.packages("remotes") remotes::install_github("rostools/prodigenr")
There are two ways of creating a new project: using the R console or using the RStudio “New Project” menu option.
Through the console, use the
setup_project() command. So, for
instance, if you want a manuscript project, type out:
This then creates a directory tree, with template files for starting
your analysis! Open the newly created project via the
.Rproj file. For
the RStudio approach, go to “File -> New Project”, then “New
directory” and find the prodigenr project in the list:
Once in the project, you can add a manuscript R Markdown file or poster using:
create_manuscript() # Or... create_poster()
The main secondary function is the
template_list command, which lists
the available template files (submit a PR if you want another template
template_list #>  "report" "slides"
For a more detailed tutorial, see the introduction vignette:
There are several existing packages for creating projects, each of which has it’s own pros and cons. Try them out and see which you like!
prodigenr tries to use ideas from R packages/devtools while still being as simple as possible and to be more specific to academic researchers primarily in biomedical/non-computer science fields. However, it can always improve! I welcome any suggestions, just submit a GitHub issue!
See the contributing documentation for information on how to contribute. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Special thanks to [@zsemnani](https://twitter.com/zsemnani?lang=en) for creating the logo!
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.