prepareProjFolder: Easy way to prepare a folder for a typical R Project

In LuisLauM/ruisu: Tools for habitual tasks (and another fancy things)

Easy way to prepare a folder for a typical R Project

Description

Easy way to prepare a folder for a typical R Project

Usage

prepareProjFolder(
  folder,
  type = 1,
  folderList = NULL,
  addRProj = TRUE,
  openAtFinish = TRUE
)

Arguments

folder	character. Path of the folder that will be created.
type	Indicates the type of sub directories that will be created (see Details).
folderList	character vector which can be used to indicate the folders that will be created inside the project folder.
addRProj	If TRUE (default), it will load a RStudio project inside the folder.
openAtFinish	If TRUE (default), the RStudio project will be opened in a RStudio window.

Details

You can indicate the set of directories that will be created using type as follows:

• 1: code, data, figures, outputs

• 2: code, data, figures, outputs, presentations

• 3: code, data, figures, outputs, presentations, docs

• 4: code, data, figures, outputs, presentations, docs, bib

• 5: code, data, figures, outputs, presentations, docs, bib, raw

The function will creates folder recursively, so the non created folders (or sub folders) specified in 'folder' will be also created.

Examples

## Not run: 
prepareProjFolder(folder = "../exampleFolder", type = 3)

## End(Not run)

LuisLauM/ruisu documentation built on March 26, 2024, 8:23 a.m.