tni.annotate.regulons {RTN} | R Documentation

## Annotate regulons with external gene set collections.

### Description

This function calculates an enrichment score between gene sets and regulons.

### Usage

    tni.annotate.regulons(object, geneSetList, regulatoryElements = NULL,
        minGeneSetSize = 15, sizeFilterMethod="posORneg",
        exponent = 1, verbose = TRUE)

### Arguments

`object` | a preprocessed object of class 'TNI' `TNI-class` already evaluated by the `tni.dpi.filter` method.
`geneSetList` | a list with gene sets.
`regulatoryElements` | a vector of valid regulatory elements (e.g. transcription factors).
`minGeneSetSize` | a single integer or numeric value specifying the minimum number of elements in a gene set that must map to elements of the gene universe. Gene sets with fewer than this number are removed from the analysis.
`sizeFilterMethod` | a single character value specifying the use of the 'minGeneSetSize' argument, which is applyed to regulon's positive and negative targets. Options: "posANDneg", "posORneg", "posPLUSneg". For "posANDneg", the number of both positive and negative targets should be > 'minGeneSetSize'; for "posORneg", the number of either positive or negative targets should be > 'minRegulonSize'; and for "posPLUSneg", the number of all targets should be > 'minGeneSetSize'.
`exponent` | a single integer or numeric value used in weighting phenotypes in GSEA (this parameter only affects the 'dES' option).
`verbose` | a single logical value specifying to display detailed messages (when verbose=TRUE) or not (when verbose=FALSE).

### Details

Using the samples available in the provided TNI object, the 'tni.annotate.regulons' calculates the enrichment of each regulon for each gene set. First, the samples are split into two groups, one with high average gene-set expression (GS_high) and the other with low average gene-set expression (GS_low). Then a gene-wise differential expression (DEG) signature is generated by comparing the GS_high vs. GS_low groups. The DEG signature is regarded as the gene-set phenotype in the cohort. A GSEA-2T approach is used to calculate the activity score (dES) of each regulon in the phenotype (for additional details on GSEA-2T, please see section 2.2 of the RTN's vignette).

### Value

A numeric matrix with dES scores between gene sets vs. regulons.

### Author(s)

Mauro Castro

### See Also

`TNI-class`

### Examples

    data(tniData)

    ## Not run:

    #compute regulons
    rtni <- tni.constructor(expData=tniData$expData,
            regulatoryElements=c("PTTG1","E2F2","FOXM1","E2F3","RUNX2"),
            rowAnnotation=tniData$rowAnnotation)
    rtni <- tni.permutation(rtni)
    rtni <- tni.bootstrap(rtni)
    rtni <- tni.dpi.filter(rtni)

    #load a gene set collection
    #here, we build three random gene sets for demonstration
    geneset1 <- sample(tniData$rowAnnotation$SYMBOL,50)
    geneset2 <- sample(tniData$rowAnnotation$SYMBOL,50)
    geneset3 <- sample(tniData$rowAnnotation$SYMBOL,50)
    geneSetList <- list(geneset1=geneset1,
                        geneset2=geneset2,
                        geneset3=geneset3)

    #compute regulon activity
    dES <- tni.annotate.regulons(rtni, geneSetList)

    ## End(Not run)

[Package RTN version 2.14.1 Index]