getEnrichments {OmicNavigator}

Get enrichments from a study

Description

Get enrichments from a study

Usage

getEnrichments(
  study,
  modelID = NULL,
  annotationID = NULL,
  testID = NULL,
  quiet = FALSE,
  libraries = NULL
)

Arguments

study

An OmicNavigator study. Either an object of class onStudy, or the name of an installed study package.

modelID

Filter by modelID

annotationID

Filter by annotationID

testID

Filter by testID

quiet

Suppress messages (default: FALSE)

libraries

The directories to search for installed study packages. If left as NULL (the default), then installed.packages will use the result of .libPaths.

Value

The object returned depends on the data available and any filters (e.g. the argument modelID):

If no filters are specified, then the object returned is a nested list, similar to the original input object.

If one or more filters are applied, then only a subset of the original nested list is returned. Technically, each filter applied is used to subset the original nested list using [[.

If no data is available, an empty list is returned (list()).