adjusted_rand_index_heatmap

<a href="https://lifecycle.r-lib.org/articles/stages.html#deprecated"><img src="figures/lifecycle-deprecated.svg?package=metasnf&version=2.1.2" alt="[Deprecated]"></a>
Defunct function to create an ARI heatmap. Please use
<code>meta_cluster_heatmap()</code> instead.

internal

Framework to facilitate patient subtyping with similarity network fusion and meta clustering. The similarity network fusion (SNF) algorithm was introduced by Wang et al. (2014) in <doi:10.1038/nmeth.2810>. SNF is a data integration approach that can transform high-dimensional and diverse data types into a single similarity network suitable for clustering with minimal loss of information from each initial data source. The meta clustering approach was introduced by Caruana et al. (2006) in <doi:10.1109/ICDM.2006.103>. Meta clustering involves generating a wide range of cluster solutions by adjusting clustering hyperparameters, then clustering the solutions themselves into a manageable number of qualitatively similar solutions, and finally characterizing representative solutions to find ones that are best for the user's specific context. This package provides a framework to easily transform multi-modal data into a wide range of similarity network fusion-derived cluster solutions as well as to visualize, characterize, and validate those solutions. Core package functionality includes easy customization of distance metrics, clustering algorithms, and SNF hyperparameters to generate diverse clustering solutions; calculation and plotting of associations between features, between patients, and between cluster solutions; and standard cluster validation approaches including resampled measures of cluster stability, standard metrics of cluster quality, and label propagation to evaluate generalizability in unseen data. Associated vignettes guide the user through using the package to identify patient subtypes while adhering to best practices for unsupervised learning.

Prashanth S Velayudhan

metasnf

Meta Clustering with Similarity Network Fusion

Xiaoqiao Xu

Prajkta Kallurkar

Ana Patricia Balbon

Maria T Secara

Adam Taback

Denise Sabac

Nicholas Chan

Shihao Ma

Bo Wang

Daniel Felsky

Stephanie H Ameis

Brian Cox

Colin Hawco

Lauren Erdman

Anne L Wheeler

adjusted_rand_index_heatmap function

<dl><dt>aris</dt>
<dd>Matrix of adjusted rand indices from <code>calc_aris()</code></dd>
<dt>order</dt>
<dd>Numeric vector containing row order of the heatmap.</dd>
<dt>cluster_rows</dt>
<dd>Whether rows should be clustered.</dd>
<dt>cluster_columns</dt>
<dd>Whether columns should be clustered.</dd>
<dt>log_graph</dt>
<dd>If TRUE, log transforms the graph.</dd>
<dt>scale_diag</dt>
<dd>Method of rescaling matrix diagonals. Can be "none"
(don't change diagonals), "mean" (replace diagonals with average value of
off-diagonals), or "zero" (replace diagonals with 0).</dd>
<dt>min_colour</dt>
<dd>Colour used for the lowest value in the heatmap.</dd>
<dt>max_colour</dt>
<dd>Colour used for the highest value in the heatmap.</dd>
<dt>col</dt>
<dd>Colour ramp to use for the heatmap.</dd>
<dt>...</dt>
<dd>Additional parameters passed to <code>similarity_matrix_heatmap()</code>,
the function that this function wraps.</dd></dl>

Arguments

<a href='https://lifecycle.r-lib.org/articles/stages.html#deprecated'><img src='figures/lifecycle-deprecated.svg' alt='[Deprecated]' /></a>
Defunct function to create an ARI heatmap. Please use
<code>meta_cluster_heatmap()</code> instead.

Heatmap of pairwise adjusted rand indices between solutions — adjusted_rand_index_heatmap

<dl>

<dt>aris</dt>
<dd>Matrix of adjusted rand indices from <code>calc_aris()</code></dd>


<dt>order</dt>
<dd>Numeric vector containing row order of the heatmap.</dd>


<dt>cluster_rows</dt>
<dd>Whether rows should be clustered.</dd>


<dt>cluster_columns</dt>
<dd>Whether columns should be clustered.</dd>


<dt>log_graph</dt>
<dd>If TRUE, log transforms the graph.</dd>


<dt>scale_diag</dt>
<dd>Method of rescaling matrix diagonals. Can be "none"
(don't change diagonals), "mean" (replace diagonals with average value of
off-diagonals), or "zero" (replace diagonals with 0).</dd>


<dt>min_colour</dt>
<dd>Colour used for the lowest value in the heatmap.</dd>


<dt>max_colour</dt>
<dd>Colour used for the highest value in the heatmap.</dd>


<dt>col</dt>
<dd>Colour ramp to use for the heatmap.</dd>


<dt>...</dt>
<dd>Additional parameters passed to <code>similarity_matrix_heatmap()</code>,
the function that this function wraps.</dd>

</dl>

Heatmap of pairwise adjusted rand indices between solutions

adjusted_rand_index_heatmap: Heatmap of pairwise adjusted rand indices between solutions

Description

Usage

Value

Arguments