create_turing {rang} | R Documentation |
Create executable research compendium according to the Turing Way
Description
This usethis
-style function creates an executable research compendium according to the Turing Way.
Usage
create_turing(
path,
add_rang = TRUE,
add_makefile = TRUE,
add_here = TRUE,
verbose = TRUE,
force = FALSE,
apptainer = FALSE
)
Arguments
path |
character, path to the project root |
add_rang |
logical, whether to run |
add_makefile |
logical, whether to insert a barebone |
add_here |
logical, whether to insert a hidden |
verbose |
logical, whether to print out messages |
force |
logical, whether to overwrite files ( |
apptainer |
logical, whether to use apptainer. |
Details
According to the Turing Way, an executable research compendium should have the following properties
Files should be organized in a conventional folder structure;
Data, methods, and output should be clearly separated;
The computational environment should be specified.
We use the structure suggested by the Turing Way:
-
data_raw
: a directory to hold the raw data -
data_clean
: a directory to hold the processed data -
code
: a directory to hold computer code -
CITATION
: a file holding citation information -
paper.Rmd
: a manuscript This function provides the a clearly separated organizational structure. Components can be changed. For example, the manuscript can be in another format (e.g. quarto, sweave) or even optional. Withadd_rang
, the computational environment can be recorded and reconstructed later.
Value
path, invisibly
References
The Turing Way: Research Compendia Gorman, KB, Williams TD. and Fraser WR (2014). Ecological Sexual Dimorphism and Environmental Variability within a Community of Antarctic Penguins (Genus Pygoscelis). PLoS ONE 9(3):e90081. doi:10.1371/journal.pone.0090081