projectname

Research Compendium of the project to test how to make an open, reproducible, sustainable analysis project.

How to cite

Please cite this compendium as:

#> 
#> Valle-Campos A (2023). "projectname: My Reproducible Project."
#> <https://github.com/avallecam/projectname>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Misc{vallecampos:2023,
#>     title = {projectname: My Reproducible Project},
#>     author = {Andree Valle-Campos},
#>     year = {2023},
#>     url = {https://github.com/avallecam/projectname},
#>     abstract = {A paragraph providing a full description of the project (on several lines...)},
#>     version = {0.0.0.9000},
#>   }

Content

This repository is structured as follow:

• data/: contains all raw data required to perform analyses

• analyses/: contains R scripts to run each step of the workflow

• outputs/: contains all the results created during the workflow

• figures/: contains all the figures created during the workflow

• R/: contains R functions developed especially for this project

• man/: contains help files of R functions

• DESCRIPTION: contains project metadata (author, date, dependencies, etc.)

• make.R: main R script to run the entire project by calling each R script stored in the analyses/ folder

Usage

First, clone this repository. You can follow steps on how to create a new Rstudio Project from a GitHub repository.

Then, run:

source("make.R")

Notes

• All required packages, listed in the DESCRIPTION file, will be installed (if necessary)
• All required packages and R functions will be loaded
• Some analyses listed in the make.R might take time

Licenses

Text and figures : CC-BY-4.0

Code : See the DESCRIPTION file

Data : CC-0 attribution requested in reuse

Contributing

Contributions are always welcome!

See our contributing guide for ways to get started.

Please adhere to this project’s Code of Conduct.

Support

For support, please see our Getting help guide.