cumulSpe: Allows to plot the amount of TS genes among the genes that...

View source: R/genes-meta-analyses.R

cumulSpeR Documentation

Allows to plot the amount of TS genes among the genes that present the highest observed correlations for gene expression between two studies once their are ranked by decreasing order. An additional plot presenting their correlations can be added to ease the interpretation

Description

Allows to plot the amount of TS genes among the genes that present the highest observed correlations for gene expression between two studies once their are ranked by decreasing order. An additional plot presenting their correlations can be added to ease the interpretation

Usage

cumulSpe(cor1, protBreadth, simul1, reference, cor2, simul2,
  labelVec = setNames(c("Protein/mRNA pairs",
  "mRNA/mRNA pairs ('ideal' reference)", "Randomised Protein/mRNA pairs"),
  c("Cor", "reference", "simul1")), relabel = TRUE, sizeLine = 1.1,
  palette, legendText = 0.92, Title, bin = 100, seed = 1323,
  CorrelationPlot = TRUE, intermediaryPlot = FALSE,
  base_family = "Linux Libertine", base_size = 11,
  centerTitle = TRUE, out = "plot")

Arguments

cor1

named numeric vector that comprises the correlation between two studies.

protBreadth

named postive integer that comprises the breadth of expression of the proteins

simul1

named numeric vector that comprises the result of the random permutations on cor1

reference

named numeric vector that comprises the correlation between two (transcriptomic) studies that can be used as a reference

cor2

named numeric vector that comprises the correlation between two studies.

simul2

named numeric vector that comprises the result of the random permutations on cor2

labelVec

named character string that allows to name the different categories to be displayed in the legend. The names should be 'cor1, 'ref', 'simul1', .... and the content the labels Default: "setNames(c("Protein/mRNA pairs", "mRNA/mRNA pairs ('ideal' reference)", "Randomised Protein/mRNA pairs"), c('Cor','reference','simul1'))"

relabel

boolean. Default: TRUE. Whether the categories should be relaballed with the content of labelVec

sizeLine

positive numeric. Size of the lines of the plot

palette

named vector of character strings. Allows to customise the colours on the plot. Names should be identical to the categories or to the content of labelVec.

legendText

positive numeric. Size of the legend text. Default: 0.92

Title

character string. Title of the plot.

bin

positive integer. For the additional plot that uses geom_point(), the interval of ranks to consider between two plotted genes.

seed

numeric. Random seed. If simul1 and simul2 are not aggregation of all the random shuffling and one want to plot a specific occurence, it allows to plot always the same for a given seed

CorrelationPlot

boolean. Default:TRUE. Whether to add the correlation plot to help for the interpretation.

intermediaryPlot

boolean. Default:FALSE. Additional plot with the percent of TS protein for a given number of (ranked) genes

base_family

character string. Name of the font to use. Default: "Linux Libertine"

base_size

positive numeric. Size of the font to use as a base.

centerTitle

boolean. Default:TRUE. Whether to centre the title or keep it on the left.

out

character string. Allows to chose the type of returned object. "plot" (default) for the plot, "DF" for the data.frame with all the initial data, and "annotatedPlot" for an annotated plot

Value

a plot or a data.frame


barzine/barzinePhdR documentation built on Nov. 23, 2024, 8:54 p.m.