Create a project directory structure, along with typical files for that project. This allows projects to be quickly and easily created, as well as for them to be standardized. Designed specifically with scientists in mind (mainly bio-medical researchers, but likely applies to other fields).
This is a project directory generator (
prodigenr) that will
create a project directory structure with template files necessary for
managing and analyzing data for a variety of projects. This allows
for a standardized approach to having a modular research project, while also
taking advantage of existing well-developed and maintained infrastructures and
processes (Rstudio and devtools).
Install via CRAN or using
devtools for the development version:
install.packages('prodigenr') # Development version devtools::install_github('lwjohnst86/prodigenr')
The main function is the
prodigen command. So, for instance, if you
want a manuscript project, type out:
library(prodigenr) prodigen(type = 'manuscript', name = 'cancerToxins', path = '/path/to/new/project')
This then creates a directory tree, with template files for starting
your analysis! The main secondary function is the
command, which lists the available template projects and files (submit
a PR if you want another template included!):
For a more detailed tutorial, see the vignette:
Or to directly preview it here.
There are several ways of creating projects, each of which has it's pros and cons.
prodigenr tries to use ideas from R packages/
devtools while still being as simple
as possible and 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
prodigen()now creates a new project structure that mimics R package development more, specifically
devtools(since it is well documented and actively maintained) (#18, #15, #14). The old style has been removed.
rfigsharescript to send to figshare (#19).
NEWS.mdfile to track changes to the package.