make_project: make_project

Description Usage Arguments Details Value Examples

Description

Load a package

Usage

1
2
3
4
5
6
7
make_project(
  project,
  path = getwd(),
  folders = c("figures", "documentation", "data", "reports", "R"),
  readme = "README.md",
  git = FALSE
)

Arguments

project

The name of the project to set-up

path

The path where the project is to be set up. Default is the current working directory

folders

Folders to generate inside the project. Default are "figures", "documentation", "data", "reports" and "R"

readme

Name and format of the description file to be generated. Default is "README.md"

git

logical. TRUE if project is to be set up qith Git. Default is FALSE.

Details

Will also download the package if it has not been previously downloaded by the user

Value

This function will only return an error message when failing, otherwise not output will be returned

Examples

1
## Not run:  make_project(project_name) 

cchossis/dsproject documentation built on Dec. 31, 2020, 9:56 p.m.