enrichment_heatmap {scsR} | R Documentation

## enrichment_heatmap

### Description

Produces an heatmap showing the enriched annotations that are found in the input vectors of gene identifiers.

### Usage

    enrichment_heatmap(genesVectors, vectorsNames, output_file=NULL, title="", limit=400, species_ncbi_taxonomy_id=9606,
                                  enrichmentType="Process", limitMultiPicture=NULL, fdr_threshold=0.05, pvalue_threshold=NULL,
                                  cexRow=NULL, cexCol=1, STRINGversion="9_05", selectTermsVector=NULL, iea = TRUE, sortingMethod="rowMeans", avoidIntersect = FALSE)

### Arguments

`genesVectors` | list containing several sorted vectors of genes (i.e. columns of the heatmap) for which to compute the enrichment in pathways (list)
`vectorsNames` | names of the vectors (to be displayed as column labels on the heatmap) (vector of strings)
`output_file` | path to an output file where to store the heatmap (this file should have the pdf extension) (character vector)
`title` | title of the heatmap graph (character vector)
`limit` | considers only the top genes in the vector (integer)
`species_ncbi_taxonomy_id` | ncbi taxonomy id of the organism (e.g. 9606 for Human) (integer)
`enrichmentType` | type of Enrichment of the heatmap (either Process or KEGG. The first tests for enrichment in GO biological processes, while the second tests for the enrichment in KEGG pathways) (character vector)
`limitMultiPicture` | number of rows of the heatmap before to start a new page in the pdf (integer)
`fdr_threshold` | considers only the rows with at least one element below this threshold (number)
`pvalue_threshold` | considers only the rows with at least one element below this threshold (number)
`cexRow` | size of the row labels (number)
`cexCol` | size of the columns' labels (number)
`STRINGversion` | specify the version of STRING to use for the enrichment annotations (by default 9_05) (character vector)
`selectTermsVector` | specify the terms to select. Each term must fully contain at least one string of this vector. This parameter can be used when we want to limit the output of the method, for example to fit the output image in one page of an article (vector of strings).
`iea` | specify whether to use Electronic Inferred Association annotations (to be used in case you are querying the GeneOntology). (boolean)
`sortingMethod` | specify whether a sorting method should be applied. For the moment, the only available method is rowMeans. (character vector)
`avoidIntersect` | specify whether a sorting method should be applied. For the moment, the only available method is rowMeans. (character vector)

### Value

matrix that is used to generate the heat map

### Author(s)

Andrea Franceschini

### Examples

    data(uuk_screen)
    data(uuk_screen_dh)
     ## Not run:
    heatmapMatrix = enrichment_heatmap( list( uuk_screen$GeneID,
                              arrange(add_rank_col(uuk_screen), log_pval_rsa)$GeneID,
                              uuk_screen_dh$GeneID
    ),
                        list("Qiagen", "Qiagen (RSA)", "Dharmacon"),
                        limit=400,
                        enrichmentType = "Process",
                        output_file=NULL,
                        title="Uuk Cell Killers",
    			selectTermsVector=c("cycle")
    )

    ## End(Not run)

[Package scsR version 1.23.0 Index]