Skip to contents

List source reports - that is, directories within src/ that look suitable for running with orderly; these will be directories that contain an entrypoint file - a .R file with the same name as the directory (e.g., src/data/data.R corresponds to data).

Usage

orderly_list_src(root = NULL, locate = TRUE)

Arguments

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 require that the directory is configured for orderly, and not just outpack (see orderly_init for details).

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 .outpack directory

Value

A character vector of names of source reports, suitable for passing to orderly_run

See also

orderly_metadata_extract for listing packets that have completed

Examples

path <- orderly2::orderly_example("default")
#>  Created orderly root at '/tmp/RtmprnCT52/file171622ef024e'
orderly2::orderly_list_src(root = path)
#> Error in orderly_src_root(root, locate): Directory does not exist: '/tmp/RtmprnCT52/file171622ef024e'