GetTopContrib: Get the top contributing genes per geneset

Description Usage Arguments

View source: R/TopContributor.R

Description

Get the top contributing genes per geneset

Usage

1
2
3
4
5
GetTopContrib(RomaData, Selected = NULL, nGenes = 0.1, Mode = "Wei",
  Plot = FALSE, ExpressionMatrix = NULL,
  ColorGradient = colorRamps::blue2red(50), cluster_cols = FALSE,
  HMTite = "Top contributing genes", OrderType = "Abs", Transpose = FALSE,
  CorMethod = "pearson")

Arguments

RomaData

list, the analysis returned by rRoma

Selected

vector, integer. The indices of the genesets to plot

nGenes

either a value between 0 and 1 or a positive integer larger than 1. If the parameter is an integer larger than 1, it will be interpreted as the number of genes to return per geneset. If the parameter is a value between 1 and 0 it will be interpreted as the ratio or genes to return per geneset (e.g., .1 indicates 10% of the genes of the geneset)).

Mode

string, the mode used to determine the top contributing genes. It can be "Wei" (gene weigths will be used) or "Cor" (pearson correlation between gene expression and module score will be used)

Plot

boolean, shoul the summary heatmap be plotted?

ExpressionMatrix

numerical matrix, the expression matrix in the same format used by the rRoma.R function

ColorGradient

vector, string. The colors used for the heatmap.

cluster_cols

boolean, should the genesets be reordered according to the dendrogram?

HMTite

scalar, string. The title of the heatmap.

OrderType

string scalar. The mode of selection for the top contributing genes. The current implementation allow "Abs" (genes with the largest weight in absolute value), "Pos" (genes with the largest weight), and "Neg" (genes with the largest negative weight)

Transpose

boolean, should the genes by plotted on the rows instead of the columns?

CorMethod

string, the method to use to compute the correlation ("pearson", "kendall", or "spearman"). Methods other than "pearson" will produce potenital problems in the derivation of statistics accociated with the correlation


Albluca/rRoma documentation built on May 5, 2019, 1:35 p.m.