Explain how a query has or has not matched. This is experimental
and the output will change. At the moment, it can tell you why a
query matches, or if fails to match based on one of a number of
&&-ed together clauses.
Usage
orderly_query_explain(
expr,
name = NULL,
scope = NULL,
subquery = NULL,
parameters = NULL,
envir = parent.frame(),
location = NULL,
allow_remote = 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")- scope
Optionally, a scope query to limit the packets searched by
pars- subquery
Optionally, named list of subqueries which can be referenced by name from the
expr.- parameters
Optionally, a named list of parameters to substitute into the query (using the
this:prefix)- envir
Optionally, an environment to substitute into the query (using the
environment:prefix). The default here is to use the calling environment, but you can explicitly pass this in if you want to control where this lookup happens.- location
Optional vector of locations to pull from. We might in future expand this to allow wildcards or exceptions.
- allow_remote
Logical, indicating if we should allow packets to be found that are not currently unpacked (i.e., are known only to a location that we have metadata from). If this is
TRUE, then in conjunction with orderly_dependency you might pull a large quantity of data. The default isNULL. This isTRUEif remote locations are listed explicitly as a character vector in thelocationargument, or if you have specifiedfetch_metadata = TRUE, otherwiseFALSE.- 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).