new_project: Create new project scaffolding.

View source: R/new_project.R

new_projectR Documentation

Create new project scaffolding.

Description

Create all the scaffolding for a new project in a new directory. The scaffolding includes a DESCRIPTION and NAMESPACE file, .gitignore, different folders to hold raw data, outputs, documents, figures, and scripts, as well as RProject infrastructure. Also, optionally, set a GitHub repo and exclude geo data directories.

Usage

new_project(name, path = getwd(), github = FALSE, private_repo = TRUE)

Arguments

name

Name of the new project. A new folder will be created with that name.

path

Path of the new project where the folder is created. If empty then the current working directory is used.

github

Logical. Create GitHub repo? Note this requires a GITHUB_PAT. See instructions https://gist.github.com/Z3tt/3dab3535007acf108391649766409421here.

private_repo

Logical. Should the repo be private or public? Default is TRUE which equals to private.

Value

A new directory with a project structure based on the common package structure, slightly modified. Also includes scripts for start and end of each project.


EcoDynIZW/d6 documentation built on March 21, 2024, 12:41 a.m.