Cleanup Folders

Description

Remove empty folders from the folders list as well as the configuration file.

Usage

cleanup_folders(folders, conf_file = NULL, keep_conf = TRUE, recursive = FALSE)

Arguments

Value

(integer) A vector of results: 0 for success; 1 for failure; NULL for skipped.

Details

Each empty folder in the list of folders will be removed. If recursive is set to TRUE, then empty subfolders will be removed first. The configuration file will be removed if keep_conf is set to FALSE.

Examples

# Create list of standard folder names and store in a configuration file
conf_file <- tempfile("folders.yml")     # Using tempfile() for testing only
folders <- get_folders(conf_file)

# Testing only: Append folder names to parent folder path --
#               This would NOT be needed or desired in normal usage
folders <- lapply(folders, function(x) file.path(tempdir(), x))

# Create a folder for each item in "folders" list
result <- create_folders(folders)

# Remove empty folders, leaving only those with files or subfolders in them
result <- cleanup_folders(folders)

Create Folders

Description

Create a standardized set of folders under a parent folder of an R project.

Usage

create_folders(folders, showWarnings = FALSE, recursive = TRUE)

Arguments

Value

(vector) A named vector for the results of "dir.create" operations.

Details

For each folder in the "folders" list, here::here() and base::dir.create() are used to create a subfolder under the parent folder. Warnings are silenced in case the folder already exists. Recursive folder creation is supported. These two features can be controlled with the "showWarnings" and "recursive" parameters. A TRUE value in the returned vector means the folder was created by dir.create(). If a folder already exists, the returned vector will have a FALSE value for that folder.

Examples

# Create list of standard folder names and store in a configuration file
conf_file <- tempfile("folders.yml")     # Using tempfile() for testing only
folders <- get_folders(conf_file)

# Testing only: Append folder names to parent folder path --
#               This would NOT be needed or desired in normal usage
folders <- lapply(folders, function(x) file.path(tempdir(), x))

# Create a folder for each item in "folders" list
result <- create_folders(folders)

# Check results
file.exists(conf_file)
sapply(folders, dir.exists)

# Create a data file and confirm that it exists
df <- data.frame(x = letters[1:3], y = 1:3)
file_path <- here::here(folders$data, "data.csv")
write.csv(df, file_path, row.names = FALSE)
file.exists(file_path)

Get Folders

Description

Return a named list of standard folder names. Save a config file if missing.

Usage

get_folders(conf_file = NULL, conf_name = Sys.getenv("R_CONFIG_NAME"))

Arguments

Value

(list) The named folders for a standard file structure, will be returned as a list.

Details

The list of folders can be used to create any which are missing or to refer to a folder path by name to avoid hardcoding paths in scripts. You can refer to folders in this way to avoid the use of setwd() in scripts.

Ideally the folder paths will be subfolders relative to the parent folder and will be standard names used in several projects for consistency.

If there is a configuration file, then it will be read with config::get(). Otherwise a built-in default list will be returned. If you want to use a list from a non-default section of the configuration file, set the name of the section with the "conf_name" parameter.

Examples

folders <- get_folders()                 # Configuration file not used
conf_file <- tempfile("folders.yml")     # Using tempfile() for testing only
folders <- get_folders(conf_file)
folders <- get_folders(conf_file, conf_name = "custom")
Sys.setenv(R_CONFIG_NAME = "custom")
folders <- get_folders(conf_file)