/pRojects

R Package 📦 for making projects for various R activities :nut_and_bolt:

Primary LanguageRGNU General Public License v3.0GPL-3.0

pRojects

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Build Status Coverage Status Locke Data Slack

This package is designed to take away some grunt work around setting up new projects.

All projects get setup with Git and Travis by default.

  • Use createPackageProject to setup a project with code coverage, vignettes, unit testing etc out of the box
  • Use createAnalysisProject to get a project ready for a typical analysis project. It includes packrat to help with reproducibility.
  • Use createTrainingProject to get a project ready for delivering training that often involves handouts and presentation materials. It includes packrat to help with reproducibility.

Install pRojects

remotes::install_github("lockedata/pRojects")

RStudio gadget

If you want to set up a pRoject without using the R functions, @jonmcalder made a nifty RStudio addin for making pRojects. Install the package to get it added to your RStudio instance.

Contributing

General info

Wanna report a bug or suggest a feature? Great stuff! For more information on how to contribute check out our contributing guide.

Please note that this R package is released with a Contributor Code of Conduct. By participating in this package project you agree to abide by its terms.

Up for grabs

Make sure to check out the Issues tab in GitHub! We’re making this project a great place to start contributing to R packages. We will help you through the process.