Pull one or more packets (including all their files) into this archive from one or more of your locations. This will make files available for use as dependencies (e.g., with orderly_dependency).
Usage
orderly_location_pull(
expr,
name = NULL,
location = NULL,
fetch_metadata = FALSE,
recursive = NULL,
options = NULL,
root = NULL
)Arguments
- expr
The query expression. A
NULLexpression matches everything.- name
Optionally, the name of the packet to scope the query on. This will be intersected with
scopearg and is a shorthand way of runningscope = list(name = "name")- location
Optional vector of locations to pull from. We might in future expand this to allow wildcards or exceptions.
- fetch_metadata
Logical, indicating if we should pull metadata immediately before the search. If
locationis given, then we will pass this through to orderly_location_fetch_metadata to filter locations to update. If pulling many packets in sequence, you will want to update this option toFALSEafter the first pull, otherwise it will update the metadata between every packet, which will be needlessly slow.- recursive
If non-NULL, a logical, indicating if we should recursively pull all packets that are referenced by the packets specified in
id. This might copy a lot of data! IfNULL, we default to the value given by the the configuration optionrequire_complete_tree.- options
DEPRECATED. Please don't use this any more, and instead use the arguments
location,allow_remoteandfetch_metadatadirectly.- 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 anyoutpackroot (see orderly_init for details).