as.background {background} R Documentation

cast the cluster data as the enrichment background

Description

Usage

as.background(clusters,
    background.size = -1,
    name = "n/a",
    tax.id = "n/a",
    desc = "n/a",
    omics = Transcriptomics,
    filter.compoundId = TRUE,
    kegg.code = NULL);

Arguments

clusters

background.size

[as integer]

name

[as string]

tax.id

[as string]

desc

[as string]

omics

Create a enrichment background model for run multiple omics data analysis? this parameter is only works for the kegg pathway model where you are speicifc via the clusters. [as OmicsData]

filter.compoundId

do compound id filtering when target model is omics. [as boolean]

kegg.code

the kegg organism code when the given clusters. [as string]

env

[as Environment]

Details

Authors

gseakit

Value

this function returns data object of type Background.

clr value class

Examples

[Package background version 1.0.0.0 Index]