get_enrichment_options.link-glm: Available options for the enrichment objects of class link-glm
Description
Available options for the enrichment objects of class link-glm
Usage
# S3 method for `link-glm`
get_enrichment_options(object, option,
all_options = missing(option))
Arguments
object
the object to be enriched
option
a character vector listing the options for enriching
the object
all_options
if TRUE then output a data frame with the
available enrichment options, their descriptions, the names of
the components that each option results in, and the names of
the corresponding compute_* functions.
Value
an object of class enrichment_options
Details
A check is being made whether the requested option is
available. No check is being made on whether the functions that
produce the components exist.