sum_distance: Sum the distance of all branches in a dendrogram

View source: R/sum_distance.R

sum_distanceR Documentation

Sum the distance of all branches in a dendrogram

Description

This function takes a dendrogram class object as an input, and adds up all the distances of branches. This function is called recursively to adds up the sum. In case of exponential mapping for the quantitative mode, the sum is in the exponential scale

Usage

sum_distance(
  d,
  sum = 0,
  mapping = c("exponential", "linear"),
  scale = 0,
  max_height = 0,
  ...
)

Arguments

d

dendrogram class object

sum

the sum of distance

mapping

in case of quantitative mode, either "linear" or "exponential" mapping

...

ignored

Value

the sum of distances


gapmap documentation built on May 29, 2024, 4:39 a.m.