plotMetricsCluster: Metric values clustering.

View source: R/metricsAnalysis.R

plotMetricsClusterR Documentation

Metric values clustering.

Description

It clusters the value of the metrics in a SummarizedExperiment object a an hclust dendogram from stats. By default distance is measured in 'euclidean' and hclust method is 'ward.D20.

Usage

plotMetricsCluster(data, scale = FALSE, k = NULL)

Arguments

data

A SummarizedExperiment. The SummarizedExperiment must contain an assay with the following structure: A valid header with names. The first column of the header is the ID or name of the instance of the dataset (e.g., ontology, pathway, etc.) on which the metrics are measured. The other columns of the header contains the names of the metrics. The rows contains the measurements of the metrics for each instance in the dataset.

scale

Boolean. If true input data is scaled. Default: FALSE.

k

Integer. If not NULL a 'cutree' cut on the cluster is done. Default: NULL

Value

An hclust object.

Examples

# Using example data from our package
data("ontMetrics")
plotMetricsCluster(ontMetrics, scale=TRUE)


neobernad/evaluomeR documentation built on Nov. 12, 2024, 11:29 p.m.