rrtools (version 0.1.5)

use_compendium: Creates an R package suitable to use as a research compendium, and switches to the working directory of this new package, ready to work

Description

This is usethis::create_package() with some additional messages to simplify the transition into the new project setting

Usage

use_compendium(
  path = getwd(),
  fields = getOption("usethis.description"),
  rstudio = rstudioapi::isAvailable(),
  open = TRUE,
  quiet = FALSE,
  simple = TRUE,
  welcome_message = TRUE
)

Arguments

path

location to create new package. The last component of the path will be used as the package name

fields

list of description values to override default values or add additional values

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

quiet

if FALSE, the default, prints informative messages

simple

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

welcome_message

if TRUE, rstudio, open and not quiet, then the .Rprofile file in the newly created package is prepopulated with a welcome message.