chellinger: Calculate the Hellinger distance for each species.

View source: R/cmahalanobis.R

chellingerR Documentation

Calculate the Hellinger distance for each species.

Description

This function takes a dataframe and a factor in input, and returns a matrix with the Hellinger distances about it.

Usage

chellinger(
  dataset,
  formula,
  plot = TRUE,
  plot_title = "Hellinger Distance Between Groups"
)

Arguments

dataset

A dataframe.

formula

A factor which you want to calculate the Hellinger distances matrix.

plot

Logical, if TRUE, a plot of Hellinger distances matrix is displayed.

plot_title

The title to be used for the plot if plot is TRUE.

Value

A matrix containing Hellinger distances between each pair of groups and the plot.

Examples

# Example with the iris dataset

chellinger(iris, ~Species, plot = TRUE, plot_title = "Hellinger Distance Between Groups")

# Example with the mtcars dataset
chellinger(mtcars, ~am, plot = TRUE, plot_title = "Hellinger Distance Between Groups")


cmahalanobis documentation built on April 3, 2025, 8:51 p.m.