start_project: Start a project

Description Usage Arguments Details Author(s) Examples

View source: R/start_project.R

Description

Configure a project directory with a logical subfolders structure. It can also init a git folder

Usage

1
  start_project(subdirs, git = TRUE)

Arguments

subdirs

[character] A vector of subdirectories to create. By default: data, results, reports and src

git

[boolean] If TRUE [default], git folder is init and contents are added and commited. Be sure having git2r package installed.

Details

This function will create all the supplied subdirectories into the project folder. It will also create a README.md file with the name of the project and the date and time of start.

If git = TRUE, git folder is init but it won't push the folder into your git repository.

Author(s)

Víctor Moreno-González <vmorg@unileon.es>

Examples

1
2
3
4
## Not run: 
start_project()

## End(Not run)

vmoreg00/projects documentation built on April 14, 2020, 4:02 p.m.