create.proj: Create project folder with preset or user given sub folders...

Description Usage Arguments Author(s) Examples

Description

Create project folder with preset or user given sub folders and a README file.

Usage

1
2
create.proj(path, parent, sub = c("code", "data", "deliverables",
  "documents"), doctype = "txt", setwd = FALSE)

Arguments

path

A file path.

parent

The project name. This becomes the top level folder for your project.

sub

(optional) Sub folders to be created within your project folder. Default folders created are "code","data","deliverables" and "documents". User can supply any number of sub folders as a list c("folder1", "folder2"). User supplied folders will overwrite the default options. For no subfolders, supply an empty list.

doctype

(optional) Specify the type of document to be created as README. Default is "txt". Any valid document type (i.e. "md", "doc") can be supplied.

setwd

(optional) Sets the newly created project as the working directory. Default is FALSE

Author(s)

Michael Golafshar

Examples

1
2
3
4
5
create.proj(path = "C:/Users/username/Desktop", parent = "my_new_project")

#create a new folder with only 2 sub folders in it along with README.md. Then, set the new project as your working directory.
filepath <- "C:/Users/username/Desktop"
create.proj(path = filepath, parent = "Project_x", sub = c("Mulder", "Scully"), doctype = "md", setwd = TRUE)

mgolafshar/kickstartR documentation built on May 12, 2019, 7:35 a.m.