createDSProject: Create directory structure for a data science project

In bhuvad/restools: Research tools for data science projects

Create directory structure for a data science project

Description

Initialise a data science project. This function creates a directory structure to help you organise your project. The structure is inspired from JEFFERY LEEKS TUTORIAL. Along with the directory structure, it creates a README file in Rmarkdown which can then be used to produce a GitHub compatible markdown document. It also creates a plot diary to help you organise plots generated during the project.

Usage

createDSProject(pname = NULL, path = ".")

Arguments

pname	a character, stating the name of the project
path	a character, specifying the location of the project

Details

The README.Rmd file is created in the project directory and the plot_diary.Rmd created in the auto generated figures folder

See Also

updateReadme

Examples

## Not run: 
# create project named "ds_project" in home folder
createDSProject('ds_project', '~')

## End(Not run)

bhuvad/restools documentation built on June 16, 2024, 12:44 a.m.