Up: Component summary Component

CorrelationReport

Creates a correlation report that shows how much columns of a numeric matrix correlate with each other. Several methods for computing correlation coefficients are supported. The report contains a heat map that visualizes correlation coefficieents and a table that shows them in numeric form.

Version 1.1
Bundle tools
Categories Latex
Authors Kristian Ovaska (kristian.ovaska@helsinki.fi), Marko Laakso (Marko.Laakso@Helsinki.FI)
Issue tracker View/Report issues
Requires R
Source files component.xml CorrelationReport.r
Usage Example with default values

Inputs

Name Type Mandatory Description
matr Matrix Mandatory Expression data; can be channel expression or log ratios.

Outputs

Name Type Description
report Latex Correlation report
correlation Matrix A square matrix containing pairwise correlation coefficients (r) for the samples

Parameters

Name Type Default Description
method string "pearson" Method for computing correlation. One of "pearson", "kendall" or "spearman".
rotateLabels boolean true If true, rotate column labels vertically in the correlation coefficient matrix so that they take less space on the x axis. Note: in the heat map, column labels are always rotated.
showTable boolean true Includes correlation matrix as a table into the report.

Test cases

Test case Parameters IN
matr
OUT
report
OUT
correlation
case1 (missing) matr report correlation
case2 properties matr report correlation

showTable = false

case3 properties matr report correlation

showTable = false,
method = spearman,
rotateLabels = false


Generated 2018-12-16 07:42:13 by Anduril 2.0.0