locate_batons: Locate batons

In al-obrien/relay: Flexible workflow tracking

Locate batons

Description

Search for batons in R environment or directory.

Usage

locate_batons(
  loc = .GlobalEnv,
  relay_type = getOption("relay_type", default = c("CANCELLED", "PRACTICE",
    "COMPETITION")),
  suppress_messages = FALSE,
  ...
)

Arguments

loc	location to look for batons; default set to .GlobalEnv, file paths can also be used.
relay_type	character value for the type of the baton (e.g. 'CANCELLED', 'PRACTICE', or 'COMPETITION'); default is all of them.
suppress_messages	boolean value to determine if messages listing discovered batons are suppressed.
...	parameters passed to list.files.

Value

character vector describing location of batons in file system or in R session by name.

Examples

## Not run: 
# Using folder path
locate_batons('path/to/baton/directory')

# Check R environment
locate_batons()

# Locate specific type of batons
locate_batons(relay_type = 'PRACTICE')

# Use global option to have defaults set to just the one type
options(relay_type = 'PRACTICE')
locate_batons()

## End(Not run)

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