build_stackr_workflow_dir: Automatically build the stacks/stackr workflow directories

View source: R/build_stackr_workflow_dir.R

build_stackr_workflow_dirR Documentation

Automatically build the stacks/stackr workflow directories

Description

This prepares the different folders required to run the STACKS workflow proposed in stackr.

Usage

build_stackr_workflow_dir(main.folder.name = "stacks_run", date = TRUE)

Arguments

main.folder.name

Use this argument to customize the name of the main folder for workflow. e.g. main.folder.name = "stacks_lobster" Default: main.folder.name = "stacks_run"

date

(logical) Should the current date be appended on the main folder name? e.g. stacks_lobster_20160630 Default: date = TRUE

Value

A main folder containing different folders used during the stacks workflow proposed here.

Examples

## Not run: 
# The simplest form of the function:
stackr::build_stackr_workflow_dir()
# that's it ! Now if you have your own main folder name:
build_stackr_workflow_dir(main.folder.name = "stacks_whiteshark", date = TRUE)

## End(Not run)

thierrygosselin/stackr documentation built on April 13, 2025, 10:28 a.m.