phenoViewer: Visualization of cluster phenotypes

phenoViewerR Documentation

Visualization of cluster phenotypes

Description

The Pheno Viewer aims to visualize the phenotype of single cluster or a set of combined clusters. This representation displays median marker expressions of each sample using parallel coordinates. In such viewer, each line corresponds to a biological sample and lines are positioned on a space where the X-axis represents the cell markers and the Y-axis represents the marker expressions. If biological conditions have been assigned to the biological samples, then samples belonging to the same condition will be shown using the same color.

Marker expressions from several clusters can be combined by providing one or several cluster names to the 'clusters' parameter. In this case, the displayed marker expressions are the means of the median expressions for each cluster of each marker.

Markers used as clustering markers are shown in blue. A dashed line indicates the mean marker expressions of all samples. Importantly, a grey ribbon indicates the bounds of marker expressions in the overall dataset. The visualization can be restricted to specific markers using the 'markers' parameter.

Usage

phenoViewer(Results, samples = NULL, clusters = NULL, markers = NULL,
  show.mean = "both", show.on_device = TRUE, sort.markers = TRUE)

Arguments

Results

a Results object

samples

a character vector providing the sample names to used (all samples by default)

clusters

a character vector containing the clusters names to be visualized (by default all clusters will be displayed)

markers

a character vector specifying the markers to be displayed assignments

show.mean

a character specifying if marker means expression should be displayed, possible value are among: "none", "only" or "both"

show.on_device

a logical specifying if the representation will be displayed on device

sort.markers

a logical specifying if the markers must be sorted by names in the representation

Details

The ranges of value between marker bounds (using the 'bounds' slot) will be displayed using a grey ribbon.

The 'show.mean' parameter allows to visualize three kinds of information:

  • "none" value will show marker median expressions for each selected samples;

  • "only" value will show only the mean of median maker expressions for all selected samples (displayed as black dashed line);

  • "both" value will show marker median expressions for each selected samples together with the mean of median maker expressions for all selected samples.

Value

a 'ggplot' object


tchitchek-lab/SPADEVizR documentation built on Jan. 27, 2024, 8:58 p.m.