workflowr (version 0.3.0)

wflow_start: Start a new workflowr project.

Description

wflow_start creates a new project directory for the site.

Usage

wflow_start(name, directory, git = TRUE, overwrite = FALSE)

Arguments

name

character. Project name, e.g. "My Project"

directory

character. The directory for the project, e.g. "~/new-project". Will be created if necessary.

git

logical (default: TRUE). Should Git be used for version control? If directory is a new Git repository, wflow_start will initialize the repository and make an initial commit. If directory is already a Git repository, wflow_start will make an additional commit. In both cases, only files needed for the workflowr project will be included in the commit.

overwrite

logical (default: FALSE). Control whether to overwrite existing files . Passed to file.copy.

Details

This is the initial function that organizes the infrastructure to create a research website for your project. Note that while you do not need to use RStudio with workflowr, do not delete the Rproj file because it is required by other functions.

Examples

# NOT RUN {
wflow_start("My Project", "path/to/new-project")
# }