totals: Total sum of amounts

In compositions: Compositional Data Analysis

Total sum of amounts

Description

Calculates the total amount by summing the individual parts.

Usage

totals(x,...)
## S3 method for class 'acomp'
totals(x,...,missing.ok=TRUE)
## S3 method for class 'rcomp'
totals(x,...,missing.ok=TRUE)
## S3 method for class 'aplus'
totals(x,...,missing.ok=TRUE)
## S3 method for class 'rplus'
totals(x,...,missing.ok=TRUE)
## S3 method for class 'ccomp'
totals(x,...,missing.ok=TRUE)
          

Arguments

x	an amount/amount dataset
...	not used, only here for generic purposes
missing.ok	if TRUE ignores missings; if FALSE issues an error if the total cannot be calculated due to missings.

Value

a numeric vector of length equal to ncol(x) containing the total amounts

Missing Policy

if missing.ok=TRUE missings are just regarded as 0, if missing.ok=FALSE WZERO values is still regarded as 0 and other sorts lead to NA in the respective totals.

Author(s)

K.Gerald v.d. Boogaart http://www.stat.boogaart.de

See Also

aplus

Examples

data(SimulatedAmounts)
totals(acomp(sa.lognormals))
totals(rcomp(sa.lognormals,total=100))
totals(aplus(sa.lognormals))
totals(rplus(sa.lognormals))
aplus(acomp(sa.lognormals),total=totals(aplus(sa.lognormals)))

compositions documentation built on April 14, 2023, 12:26 a.m.