orderly (version 2.0.0)

orderly_metadata: Read outpack metadata

Description

Read metadata for a particular id. You may want to use orderly_search() to find an id corresponding to a particular query.

Usage

orderly_metadata(id, root = NULL)

Value

A list of metadata. See the outpack schema for details (https://github.com/mrc-ide/outpack)

Arguments

id

The id to fetch metadata for. An error will be thrown if this id is not known

root

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

Examples

path <- orderly_example()
id <- orderly_run("data", root = path)

# Read metadata for this packet:
meta <- orderly_metadata(id, root = path)
names(meta)

# Information on files produced by this packet:
meta$files