rrtools (version 0.1.5)

create_compendium: Quickly create a basic research compendium by combining several rrtools functions into one.

Description

In one step, this will create an R package in an empty, git initialized directory, attach the MIT license to it, add the rrtools' README to it, create the 'analysis' directory structure, and populate it with an R Markdown file and bib file. This function will not create a GitHub repository for the compendium, a Dockerfile, a Travis config file, or any package tests. Those require some interaction outside of R and are left to the user.

Usage

create_compendium(
  pkgname = getwd(),
  data_in_git = TRUE,
  rstudio = rstudioapi::isAvailable(),
  open = TRUE,
  simple = TRUE
)

Arguments

pkgname

path to an empty, git initialized directory. The last component of the path will be used as the package name. Default is the current directory name.

data_in_git

should git track the files in the data directory? Default is TRUE

rstudio

create an RStudio project file? (with usethis::use_rstudio)

open

if TRUE and in RStudio, the new project is opened in a new instance. If TRUE and not in RStudio, the working directory is set to the new project

simple

if TRUE, the default, the R/ directory is not created, because it's not necessary for many if not most research repositories