compositions (version 2.0-1)

summary.aplus: Summaries of amounts

Description

Summary of a vector of amounts, according to its underlying geometry.

Usage

# S3 method for aplus
summary( object, …, 
            digits=max(3, getOption("digits")-3), robust=NULL)
          # S3 method for rplus
summary( object, …, robust=NULL)
          # S3 method for rmult
summary( object, …, robust=NULL)

Arguments

object

an aplus/rplus set of amounts

digits

the number of significant digits to be used. The argument can also be used with rplus/rmult.

…

not used, only here for generics

robust

A robustness description. See robustnessInCompositions for details. The option is currently not supported. If support is added the default will change to getOption(robust).

Value

A matrix containing summary statistics (minimum, the three quantiles, the mean and the maximum) of each component.

Details

The obtained value is the same as for the classical summary summary, although in the case of aplus objects, the statistics have been computed in a logarithmic geometry, and exponentiated afterwards (which just changes the mean, equivalent to the geometric mean of the data set).

See Also

aplus,rplus,summary.acomp, summary.rcomp

Examples

# NOT RUN {
data(SimulatedAmounts)
summary(aplus(sa.lognormals))
summary(aplus(sa.tnormals))
summary(rplus(sa.lognormals))
summary(rplus(sa.tnormals))
summary(rmult(sa.lognormals))

# }