Print an overview of the runtime methods supported by artma, and return it
as a data frame. The table is built from the metadata each method registers
with register_runtime_method(): what it does, which data columns it needs,
which methods run before it, which optional packages it uses (and whether
they are installed), and whether it is opt-in (left out of
methods = "all").
Pass a data frame to available_for to turn the table into a pre-flight
check: each method's required columns are matched against that data, so a
method that would be skipped is visible before the run rather than after.
Usage
methods_list(available_for = NULL)
Arguments
- available_for
[data.frame, optional] Data to check each method's
required columns against. When supplied, the returned frame gains a
missing_columns column and an available flag. Defaults to NULL.
Value
[data.frame] Invisibly, one row per method, with the method,
description, required_columns, depends_on, suggests,
missing_packages, installed, and opt_in columns (plus
missing_columns and available when available_for is supplied).
Multi-value columns are comma-separated strings.
Examples
if (FALSE) { # \dontrun{
artma::methods_list()
artma::methods_list(available_for = my_data)
} # }