new_project: creates folder for a new project and adds templates for all...

View source: R/new_project.R

new_projectR Documentation

creates folder for a new project and adds templates for all the necessary files.

Description

creates folder for a new project and adds templates for all the necessary files.

Usage

new_project(project_id, name, data_folder = here::here())

Arguments

project_id

character. ID of the project, e.g. 2021-03-COR. see description for details.

name

character. short name of the project. defaults to "".

data_folder

character. path to data folder starting at root of the project. defaults to "."

Details

the project id is composed by the year-month of when the project was started (~when the kickoff took place) and a three-letter, uppercase abbreviation for the organization. If there are two projects with the same organization starting in the same month, two letters of the abbreviation should be used for the organization, and one for the content of the project. e.g. 2021-03-COV for a visualization project with CorrelAid and 2021-03-COA for an automation project with CorrelAid.


CorrelAid/projectutils documentation built on Oct. 7, 2022, 4:40 a.m.