Skip to contents

List known pack locations

Source: R/location.R
orderly_location_list.Rd

List known locations. The special name local will always be present within the output from this function (this is packets known at the current root), though you will typically be interested in other locations.

Usage

orderly_location_list(verbose = FALSE, root = NULL, locate = TRUE)

Arguments

verbose

Logical, indicating if we should return a data.frame that includes more information about the location.

root

The path to the root directory, or NULL (the default) to search for one from the current working directory if locate is TRUE. This function does not require that the directory is configured for orderly, and can be any outpack root (see orderly_init for details).

locate

Logical, indicating if the root should be searched for. If TRUE, then we looks in the directory given for root (or the working directory if NULL) and then up through its parents until it finds an .outpack directory or orderly_config.yml

Value

Depending on the value of verbose:

  • verbose = FALSE: A character vector of location names. This is the default behaviour.

  • verbose = TRUE: A data.frame with columns name, type and args. The args column is a list column, with each element being the key-value pair arguments to the location.

See also

orderly_location_pull_metadata, which can update your outpack index with metadata from any of the locations listed here.