Analysis

Expression heatmap clustering

Hierarchically cluster a genes x samples expression matrix (UPGMA/average, complete, or single linkage; Euclidean or correlation distance) and return the row/column leaf order, dendrogram merge trees, and row-z-scored values for the Clustered Expression Heatmap visualization.

post/expression_heatmap_cluster

Request

  • Base URL: https://seqbench.com/api/v1
  • URL: https://seqbench.com/api/v1/expression_heatmap_cluster
  • Auth: none required

Request body

genesstring[] required

Row (gene) labels.

samplesstring[] required

Column (sample) labels.

clusterRowsboolean

Cluster (reorder) genes.

clusterColsboolean

Cluster (reorder) samples.

distanceMetric'euclidean' | 'correlation'

correlation = 1 - Pearson r (the standard expression-heatmap default); euclidean = straight-line distance.

linkage'average' | 'complete' | 'single'

average = UPGMA (standard default), complete = farthest-neighbor, single = nearest-neighbor.

zScoreRowsboolean

Row-wise z-score each gene's values before clustering and returning (the conventional 'relative expression' heatmap normalization — the dendrograms are computed on the same scaled matrix the heatmap shows, as in seaborn's clustermap(z_score=0) / pheatmap's scale="row").

Response

Tool ran successfully.

okunknown required
toolstring required

The tool slug that ran.

resultobject required

Tool-specific output object. Its shape depends on the tool — call GET /{tool} or see the docs for each tool's fields.

Example response

{
  "provenance": {
    "apiVersion": "1.1.0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.