Generic method for getting available options for the enrichment of objects
get_enrichment_options(object, option, all_options)
the object to be enriched
a character vector listing the options for enriching the object
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.
if all_options = TRUE
then an object of class
enrichment_options
is returned, otherwise if
option
is specified the output is a character vector
with the names of the functions that compute the enrichment
components
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.