create_MATSS_compendium: Create a research compendium for MATSS

In weecology/MATSS: Macroecological Analyses of Time Series Structure

Description

Create an R package, using use_package, then perform the following additional actions:

• add various package dependencies, including "MATSS"

• add template analysis and pipeline files

Usage

create_MATSS_compendium(
  path,
  name = usethis:::find_name(),
  fields = NULL,
  rstudio = rstudioapi::isAvailable(),
  open = interactive(),
  DEPLOY = FALSE
)

Arguments

path	A path. If it exists, it is used. If it does not exist, it is created, provided that the parent path exists.
name	author name for the package
fields	A named list of fields to add to DESCRIPTION, potentially overriding default values. See use_description() for how you can set personalized defaults using package options
rstudio	If TRUE, calls use_rstudio() to make the new package or project into an RStudio Project. If FALSE and a non-package project, a sentinel .here file is placed so that the directory can be recognized as a project by the here or rprojroot packages.
open	If TRUE, activates the new project: If RStudio desktop, the package is opened in a new session. If on RStudio server, the current RStudio project is activated. Otherwise, the working directory and active project is changed.
DEPLOY	if TRUE, add preamble text to the readme

Value

Path to the newly created package, invisibly.

weecology/MATSS documentation built on May 15, 2020, 7:03 p.m.