Templates for R

This repository contains commonly used file templates for R projects (package, compendium, website, book, etc.). These templates are used by the R package rcompendium to create the structure of a R package or a research compendium.

You can use these templates without using rcompendium, but remember to adapt them to your project, especially the elements enclosed in double curly braces (i.e. {{project_name}}).

Content

This repository is structured as follow:

• actions/: contains configuration files for GitHub Actions relevant to R projects
• air/: contains configuration files for Air, a formatter and language server for R code
• contributing/: contains markdown files providing guidelines to contribute to the project and a code of conduct
• docker/: contains a generic Dockerfile (and a .dockerignore) for basic R projects
• git/: contains a generic .gitignore for R projects
• hexsticker/: contains the material (including R code) to generate an HexSticker for your project
• issues/: contains GitHub Issues templates (bug reporting, feature request, etc.)
• licenses/: contains commonly used licenses for R projects. More licenses can be found here
• others/: contains various files for R projects (e.g. make.R)
• package/: contains mandatory files to create a basic structure of a R package (e.g. DESCRIPTION, CITATION, etc.)
• readme/: contains two Rmarkdown templates to generate README (one specific for R package and one for research compendium)

License

This repository is released under the MIT license.