describe a module

Source: R/modules.R

describe a module

describe_module(
  compendium = "vespucci",
  module = NULL,
  normalization = "limma"
)

Arguments

compendium

A string - the selected compendium
module

A matrix with valid rownames (biofeatureNames) and colnames (samplesetsNames)
normalization

A string - either 'limma' (default),'tpm' or legacy as normalization

Value

a list of three: "originalIds", "termShortName" and "samples"

Examples

if (FALSE) {
gene_names <- c('VIT_00s0246g00220','VIT_00s0332g00060','VIT_00s0332g00110',
'VIT_00s0332g00160','VIT_00s0396g00010','VIT_00s0505g00030','VIT_00s0505g00060'
,'VIT_00s0873g00020','VIT_00s0904g00010')
module_1 <- create_module(biofeaturesNames=gene_names, normalization = "limma")
d_module <- describe_module(module = module_1, normalization = "limma")
}