orderly_list_metadata {orderly}

List reports with only local metadata

Description

List reports that are present only as metadata; these are the result of doing orderly_pull_archive() with recursive = FALSE, in which case only metadata was downloaded and not the report contents itself.

Usage

orderly_list_metadata(root = NULL, locate = FALSE, include_archive = FALSE)

Arguments

root

The path to an orderly root directory, or NULL (the default) to search for one from the current working directory if locate is TRUE.

locate

Logical, indicating if the configuration should be searched for. If TRUE and config is not given, then orderly looks in the working directory and up through its parents until it finds an orderly_config.yml file.

include_archive

Logical, indicating if we should include reports that are also included in the archive.

Value

A data.frame() with columns name and id, as for orderly_list_archive()

Examples

path <- orderly::orderly_example("minimal")
# No metadata-only reports will be present, unless you have run
# orderly::orderly_pull_archive(..., recursive = FALSE)
orderly::orderly_list_metadata(path)