folder_setup: Setup Folder Structure in Project

In USAID-OHA-SI/glamr: SI Utilities Package

Setup Folder Structure in Project

Description

'folder_setup()' creates an organizational structure that is common across OHA/SI projects so every analyst knows what to expect and where when picking up a new project or one cloned from a co-worker. This function can be used as a stand alone function but primarily serves 'si_setup()'

Usage

folder_setup(
  folder_list = list("Data", "Images", "Scripts", "AI", "Dataout", "Data_public", "GIS",
    "Documents", "Graphics", "markdown")
)

Arguments

folder_list

list of folders to install

Details

The standard setup provides the following folders for these uses: * Data - where any raw/input data (**xlsx/csv/rds**) specific to the project are stored * Dataout - where any intermediary or final data (**xlsx/csv/rds**) are output as a product of your code * Data_public - where all public data lives * * Scripts - where all the code (**R/py**) are stored (if there is a local order, make sure to add prefixes to each script, e.g. 00_init.R, 01_data-access.R, 02_data-munging.R, ...) * Images - any **png/jpeg** visual outputs from your code * Graphics - any **svg/pdf** visual outputs that will be edited in vector graphics editor, eg Adobe Illustrator or Inkscape * AI - any **ai** files or other files from a graphics editor (exported pngs products will be stored in Images) * GIS - any **shp** files or other GIS releated inputs * Documents - any **docx/xlsx/pptx/pdf** documents that relate to the process or are final outputs * markdown - exported **md** files from a knitr report

See Also

Other project setup: setup_gitignore(), setup_readme(), si_setup()

Examples

## Not run: 
#standard
  folder_setup()
#specific
  fldrs <- c("Data", "Tableau", "AI")
  folder_setup(fldrs)

## End(Not run)

USAID-OHA-SI/glamr documentation built on Oct. 1, 2024, 2:18 p.m.