create_proj_folders: Create folder with structure for analysis

View source: R/create_proj_folders.R

create_proj_foldersR Documentation

Create folder with structure for analysis

Description

A helper function that will create folders for an analysis project in the directory that is specified. Note that established folders should not be overwritten since this funcion relies on fs::dir_create() but do use caution.

Usage

create_proj_folders(
  main_dir = getwd(),
  sub_dir = NULL,
  is_iit = FALSE,
  folder_names = c("admin", "code", "data", "deliverables", "docs")
)

Arguments

main_dir

File path to the main directory where you want to create folders. Default is the current working directory (getwd())

sub_dir

Name of the sub-directory where you want to create folders. Default is Null; folder can be completely specified using main_dir if you'd like.

is_iit

Default is FALSE and the default folder names below are used. If TRUE then the following BSR IIT folders are used c("Admin", "Data", "Code", "Protocol", "EDC", "Deliverables", "Publishing")

folder_names

A character vector of the folder names to create in the directory that you specified. Defaults are 'c("admin", "code", "data", "deliverables", "docs").

Examples

## Not run: 
create_proj_folders(main_dir = "/Users/latour/Desktop/",
                    sub_dir = "new_folder")

## End(Not run)

emilelatour/lamisc documentation built on April 9, 2024, 10:33 a.m.