createProject: Create New Pudding Project

In the-pudding/puddingR: Pudding Helper Functions

Description

Creates a new R project and generates the folders needed for consistent Pudding analysis

Usage

create_project(name = "analysis", title = "My analysis",
  folder = getwd(), dirs = c("assets", "assets/data",
  "assets/data/open_data", "plots", "assets/data/processed_data",
  "assets/data/raw_data", "reports", "rmds"), packagedeps = "packrat",
  reset = FALSE, open = FALSE, defaultRmd = TRUE,
  brand = "pudding")

Arguments

name	File name for the project. Default: "analysis"
title	What the project does, one line, title case, Default: "My Analysis"
folder	Folder under which to create the new project, Default: getwd()
dirs	Character vector of new directories to create, Default: c("assets", "functions", "open_data", "plots", "processed_data", #' "raw_data", "reports", "rmds", "rscripts")
packagedeps	Set which tool you would like to use for package reproducibility, Default: 'packrat'
reset	Whether to reset the active project to your old project, Default: FALSE
open	Whether the new project should open a new session, Default: FALSE
defaultRmd	Whether to automatically create an Rmd file to get you started, Default: TRUE
brand	How should the default Rmd file be branded? Options: "pudding", "polygraph", Default: 'pudding'

Details

DETAILS

Value

OUTPUT_DESCRIPTION

See Also

proj_utils,use_description isAvailable,projects desc_set

Examples

## Not run: 
folder <- tempdir()
createProject(
  name = "pudding-analysis", title = "My Next Great Story",
  folder = folder,
  packagedeps = "checkpoint",
  reset = TRUE,
  open = FALSE
)
list.files(file.path(folder, "pudding-analysis"))
unlink(file.path(folder, "pudding-analysis"))

## End(Not run)

the-pudding/puddingR documentation built on June 25, 2019, 12:15 a.m.