In 2DegreesInvesting/r2dii.usethis: Automate Package And Project Setup

knitr::opts_chunk$set(
  echo = TRUE,
  comment = "#>",
  error = TRUE,
  collapse = TRUE
)

The goal of this article is to show how to build r2dii-like packages. All code should run in R (default), or a Unix-like terminal (commented with # bash).

For a more general explanation see https://r-pkgs.org/whole-game.html.

Setup

Setup a GitHub repo, and clone it locally.
Create a basic R package.

usethis::create_package("../r2dii.packagename")

Create then open an RStudio project.

usethis::use_rstudio()

Add minimal infrastructure

Attach useful packages.

library(r2dii.usethis)
library(usethis)
library(devtools)

Add a license.

# Public for projects that are mainly code
use_mit_license()

# Public for projects that are mainly data
use_cc0_license()

# Private
use_proprietary_license()

Allow opening the GitHub repo with browse_github().

use_github_links()

Enable markdown syntax in R documentation.

use_roxygen_md()

Edit the DESCRIPTION file manually.
Tidy DESCRIPTION.

use_tidy_description()

Check.

# Control + Shift + E
check()

Confirm that R CMD check runs with 0 errors, 0 warnings, and 0 notes.
On GitHub consider tweaking collaboration and branch settings. For example:
- Add a rule for branches matching the pattern "master", and
- Restrict who can push to matching branches.

browse_github()

Extend infrastructure with templates

Install the package.

install()

Create README.Rmd from a template.

# Setup readme (e.g. adds a line to .buildignore)
usethis::use_readme_rmd()

# Overwrite pre-existing file 'README.Rmd' with r2dii's template
use_template("README.Rmd", package = "r2dii.usethis")

use_cran_badge()