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(
...,
parameters = NULL,
envir = parent.frame(),
options = NULL,
root = NULL
)Arguments
- ...
Arguments passed through to orderly_query, perhaps just a query expression
- 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.- options
Optionally, a orderly_search_options object for controlling how the search is performed, and which packets should be considered in scope. If not provided, default options are used (i.e.,
orderly2::orderly_search_options())- root
The path to the root directory, or
NULL(the default) to search for one from the current working directory iflocateisTRUE. This function does not require that the directory is configured for orderly, and can be anyoutpackroot (see orderly_init for details).