R: Available options for the enrichment objects of class 'glm'

get_enrichment_options.glm

R Documentation

Available options for the enrichment objects of class `glm`

Available options for the enrichment objects of class glm

## S3 method for class 'glm'
get_enrichment_options(object, option,
  all_options = missing(option))

`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.

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.

an object of class enrichment_options

## Not run: 
get_enrichment_options.glm(option = "all")
get_enrichment_options.glm(all_options = TRUE)

## End(Not run)