summary.cma {analogue}

Summarise the extraction of close modern analogues

Description

summary method for class "cma".

Usage

## S3 method for class 'cma'
summary(object, ...)

Arguments

object

an object of class "cma", usually the result of a call to cma.

...

arguments passed to or from other methods.

Value

An object of class "summary.cma" with the components of an object of class cma, plus:

distances

a matrix of distances/dissimilarities. Individual columns contain the ordered close modern analogues for individual fossil samples. Rows of this matrix refer to the k^{\mathrm{th}} closest analogue for each fossil sample. See notes below.

samples

a matrix of sample names from the reference set that are close modern analogues for a fossil sample. Individual columns contain the ordered close modern analogues for individual fossil samples. Rows of this matrix refer to the k^{\mathrm{th}} closest analogue for each fossil sample. See notes below.

Note

Currently, only objects of class analog are supported. The number of rows in the returned matrices is equal to the maximum number of close modern analogues identified for an individual fossil sample. If no close modern analogues exist for an individual fossil sample are identified, then the relevant column in "distances" will contain all missing values and in "samples" the string "none". Rows of individual columns will be padded with missing values if the number of close modern analogues for that sample is less than the maximum number of close modern analogues identified for a single sample.

Author(s)

Gavin L. Simpson

See Also

cma

Examples

## Not run: 
## continue the RLGH example from ?join
example(join)

## analog matching between SWAP and RLGH core
swap.analog <- analog(swapdiat, rlgh, method = "chord")
swap.analog
summary(swap.analog)

## close modern analogues
swap.cma <- cma(swap.analog, cutoff = 0.6)
swap.cma
summary(swap.cma)

## End(Not run)