prj_start: Creates project structure at the specified path.

In RSuite: Supports Developing, Building and Deploying R Solution

Description

Creates project structure at the specified path.

Usage

prj_start(name = NULL, path = getwd(), skip_rc = FALSE,
  tmpl = "builtin")

Arguments

name	name of the project to create. It must not contain special characters like \/\"\'<> otherwise project folder could not be created. It can be NULL. If so project will be created at path directly with the name of the first folder. (type: character).
path	path to the folder where project structure should be created.
skip_rc	if TRUE skip adding project under revision control. (type: logical, default: FALSE)
tmpl	name of the project template (or path to it) to use for project structure creation. (type: character).

Details

The project is not loaded, just created.

If name passed folder under such name will be created and project structure will be placed under it. If not passed folder under path will contain project structure and project name will be assumed to be basename of the path.

Logs all messages from the building process onto the rsuite logger. Use logging::setLevel to control logs verbosity. DEBUG level turns on building and downloading messages.

Project templates have to include a PARAMETERS file

Value

rsuite_project object for the project just created.

See Also

Other in project management: prj_build, prj_clean_deps, prj_init, prj_install_deps, prj_load, prj_lock_env, prj_pack, prj_start_package, prj_unload, prj_zip

Examples

# create exemplary project base folder
prj_base <- tempfile("example_")
dir.create(prj_base, recursive = TRUE, showWarnings = FALSE)

# start project
prj <- prj_start("my_project", skip_rc = TRUE, path = prj_base)

RSuite documentation built on June 10, 2019, 5:03 p.m.