orderly_list {orderly}

List orderly reports

Description

List the names of reports known to orderly. These are the source names, not the results of running reports. Note that if a report has been committed from a different branch it will not appear here, as this is simply the set of reports in the src directory that can be run.

Usage

orderly_list(root = NULL, locate = TRUE)

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.

Value

A character vector of report names

See Also

orderly_list_archive() and orderly_list_drafts(), which list archived (committed) and draft reports and their versions.

Examples

# The orderly demo, with lots of potential reports:
path <- orderly::orderly_example("demo")

# Reports that _could_ be run:
orderly::orderly_list(path)