Skip to contents

Parameterized fast gene set enrichment analysis (GSEA)

Source: R/AllGenerics.R, R/FgseaList-methods.R
FgseaList.Rd

Extends the functionality of fgsea::fgsea().

Usage

FgseaList(object, ...)

# S4 method for class 'DESeqAnalysis'
FgseaList(
  object,
  keyType = c("geneName", "ensemblGeneId", "ncbiGeneId"),
  value = c("stat", "log2FoldChange"),
  proteinCodingOnly = FALSE,
  ...
)

# S4 method for class 'DESeqResults'
FgseaList(
  object,
  keyType = c("geneName", "ensemblGeneId", "ncbiGeneId"),
  value = c("stat", "log2FoldChange"),
  rowRanges,
  proteinCodingOnly = FALSE,
  ...
)

# S4 method for class 'RankedList'
FgseaList(object, geneSetFiles)

Arguments

object

Object.

...

Additional arguments.

keyType

`character(1). Gene identifier format:

  • "geneName": Gene names (a.k.a. symbols; e.g. "TP53").

  • "ensemblGeneId: Ensembl gene identifiers (e.g. "ENSG00000000003").

  • "ncbiGeneId": NCBI (Entrez) gene identifiers (e.g. 7157).

value

character(1). Value type to use for GSEA ranked list.

Currently supported:

  1. stat: Wald test statistic. This column is returned by results() but is removed in DESeq2::lfcShrink() return, currently.

  2. log2FoldChange: Shrunken log2 fold change. Note that this option requires DESeq2::lfcShrink() return to be slotted.

  3. padj: Adjusted P value. This don't provide directional ranks, but is offered as a legacy option. Not generally recommended.

proteinCodingOnly

logical(1). Restrict to protein coding genes only.

rowRanges

GenomicRanges or GenomicRangesList. Genomic ranges (e.g. genome annotations). Metadata describing the assay rows.

geneSetFiles

character. Gene set file paths (i.e. GMT files). MSigDB files are recommended by default.

Value

FgseaList.

Note

Updated 2023-10-04.

Examples

data(deseq, package = "DESeqAnalysis")

## DESeqAnalysis ====
object <- deseq
geneSetFiles <- prepareGeneSetFiles(
    dir = system.file(
        "extdata",
        "msigdb",
        "7.0",
        "msigdb_v7.0_GMTs",
        package = "AcidGSEA"
    )
)
#> ℹ Detected 1 GMT file of `keyType` "geneName" in /private/var/folders/pt/1g5629f1699dfjwdfh32q50m0000gn/T/RtmpJ08i5p/temp_libpathe4a5396ef5e/AcidGSEA/extdata/msigdb/7.0/msigdb_v7.0_GMTs.
fgsea <- FgseaList(
    object = object,
    geneSetFiles = geneSetFiles
)
#> → Running parameterized fast GSEA.
#> Gene set files:
#> • h_all_v7_0_symbols
#> Contrasts:
#> • condition_B_vs_A
#> • treatment_D_vs_C
#> Error in vapply(X = X, FUN = FUN, FUN.VALUE = logical(1L), ..., USE.NAMES = useNames): formal argument "USE.NAMES" matched by multiple actual arguments
print(fgsea)
#> Error: object 'fgsea' not found