create_project: Create a project specific to UMR1283 storage architecture

View source: R/create_project.R

create_projectR Documentation

Create a project specific to UMR1283 storage architecture

Description

Create a project specific to UMR1283 storage architecture

Usage

create_project(
  path,
  analyst_name,
  git_repository,
  mran = FALSE,
  targets = TRUE,
  xaringan = FALSE,
  working_directory = NULL,
  ...
)

Arguments

path

A character string. A path to where the project is to be created.

analyst_name

A character string. The name of the analyst in charge of that project.

git_repository

A character string. URL to the git server/repository.

mran

A boolean. If TRUE, uses paste0("https://mran.microsoft.com/snapshot/", Sys.Date()) as the CRAN repository. Default is FALSE.

targets

A boolean. If TRUE, uses use_targets() to create directory tree for use with targets. Default is TRUE.

xaringan

A boolean. If TRUE, uses use_xaringan() to create directory tree for use with xaringan template (i.e., "https://github.com/umr1283/xaringan-template"). Default is FALSE.

working_directory

A character string. If specified, a symbolic link to the working directory will be created in the project directory under outputs, otherwise (default), outputs is a directory.

...

not used

Examples


if (interactive()) {
  create_project(
    path = "_test_project",
    analyst_name = "Analyst Name",
    git_repository = "http://gitlab.local/BioStats",
    mran = FALSE,
    targets = TRUE,
    xaringan = FALSE,
    working_directory = NULL
  )
}

umr1283/umr1283 documentation built on Nov. 27, 2022, 5:17 p.m.