create_bundle: Create a bundle

In al-obrien/relay: Flexible workflow tracking

Create a bundle

Description

create_bundle is a helper function to create a set of skeleton folders under a main bundle directory.

Usage

create_bundle(baton, dir, tree = NULL, tag = "_bundle-", mode, ...)

Arguments

baton	R object of S3 class, created by create_baton.
dir	character value for location to create the bundle on the file system.
tree	character vector for sub directories; default has no sub-directories set.
tag	character value for prefixed label to the bundled folder.
mode	passed to Sys.chmod.
...	passed to dir.create.

Details

Creating a bundle can be done at the same time as create_baton. However, it can be used without a baton as well to easily make a set of empty folders to populate later. When using as part of a {relay}, the primary purpose is to store information that passes checks from batons.

Value

Character vector for the location of created bundle.

Examples

## Not run: 
create_bundle(my_baton, dir = '/path/to/relay/raw_bundle',
              tree = c('raw', 'processed', 'metadata', 'output', '/raw/sub-raw'))

## End(Not run)

al-obrien/relay documentation built on May 6, 2023, 10:19 p.m.