calcSimplexStats: Calculate sample statistics pertinent to the simplex

View source: R/GcClusterFunctions.R

calcSimplexStatsR Documentation

Calculate sample statistics pertinent to the simplex

Description

Calculate the sample center, total variation matrix, and the metric variance.

Usage

calcSimplexStats(gcData)

Arguments

gcData

List containing the geochemical and related data. This container is described in the package documentation.

Details

The sample statistics are described in section 5.2 of Pawlowsky-Glahn et al. (2015).

Value

A list with three elements is returned. Variable D is the number of geochemical concentrations reported for each sample.

sampleCenter

Vector of length D.

variationMatrix

Matrix of dimension D x D.

metricVariance

Scalar. The metric variance is also called the total sample variance.

References

Pawlowsky-Glahn, V., Egozcue, J.J., and Tolosana-Delgado, R., 2015, Modeling and analysis of compositional data: John Wiley and Sons, Ltd.

Examples

## Not run: 
simplexStats <- calcSimplexStats(gcData)

## End(Not run)


USGS-R/GcClust documentation built on April 17, 2023, 8:08 p.m.