starters v0.0.2

One-Liners to Setup R Projects

Setting up R project directories for teaching, presenting, analysis, package development can be a pain. starters shortcuts this by creating folder structures and setting good defaults for you.

Readme

starters

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

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

All projects get setup with Git, GitHub and Travis by default.

  • Use create_package_project() to setup a project with code coverage, vignettes, unit testing etc. out of the box

  • Use create_analysis_project() to get a project ready for a typical analysis project. It includes renv to help with reproducibility.

  • Use create_training_project() to get a project ready for delivering training that often involves handouts and presentation materials. It includes renv to help with reproducibility.

All functions implement name validation based on the guidance in “Writing R Extensions”, “[The name] should contain only (ASCII) letters, numbers and dot, have at least two characters and start with a letter and not end in a dot”.

Setup for starters

Installation

remotes::install_github("lockedata/starters")

start_here() function

Run

starters::start_here()

This function checks different aspects of your setup (git installation, gitconfig, GITHUB_PAT, DESCRIPTION default values, GitHub username guessing), that will help automatic steps later on. Most of these aspects are inspired from usethis setup article. For each aspect, if your setup needs improvements an informative error message will be thrown so you might be able to know how to proceed.

RStudio gadget

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

Other R tools (not necessarily active, vet them first) useful for starting new projects.

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.

Functions in starters

Name Description
createPackageProject Create a package the usethis way with a number of infrastructure commands executed to save you hassle
createAnalysisProject Create a project laid out for an analysis project
createBasicProject Create a very basic project directory
starters starters: Manage project directories for R starters
get_project_health Create project health report under health
createTrainingProject Create a training project
start_here Check your setup before using starters
No Results!

Vignettes of starters

Name
AnalysisProjects.Rmd
BasicProjects.Rmd
RPackages.Rmd
TrainingProjects.Rmd
starters.Rmd
No Results!

Details

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/starters)](http://www.rdocumentation.org/packages/starters)