make_project: Make Project

In aaldarmaki9/dsproject: Create Projects, Import Files, and Load Packages

Make Project

Description

make_project creates a project.

Usage

make_project(
  project,
  path = getwd(),
  folders = c("figures", "documentation", "data", "reports", "R"),
  readme = "README.md",
  git = FALSE
)

Arguments

project	the name of the project, given as a character string.
path	the path of where the project should be created, the default is the current working directory.
folders	a character vector of the folders created in the project.
readme	takes a character string as the name of a text file that it creates that introduces and explains the project being created.
git	a boolean value indicating whether to initialise a Git repository and add important files to .gitignore or not.

Details

This function will create all of the scaffolding for a new project. It will set up all of the relevant directories and their initial contents.

Value

No value is returned; this function is called for its side effects.

Examples

## Not run: make_project("project")
## Not run: make_project("project", folders = c("figures", "documentation","data", "reports", "R", "graphs"),git = TRUE)

aaldarmaki9/dsproject documentation built on July 16, 2025, 10:13 p.m.