summary.analog: Summarise analogue matching results

Description

summary method for class "analog".

Usage

# S3 method for analog
summary(object, display = c("dist", "names", "quantiles"),
        k = 10, probs = c(0.01, 0.02, 0.05, 0.1, 0.2), ...)

Value

A list with one or more of the components listed below. Attributes

"method", "train", "call" and "k" contain the dissimilarity coefficient used, whether the training set dissimilarities were saved, the matched function call and the number of close analogues to return respectively.

dists: a matrix of dissimilarities between training set samples and fossil samples. The number of rows is given by argument k. There is a column for each fossil sample.
names: a matrix of names of samples from the training set that are analogues for each fossil sample. The number of rows is given by argument k. There is a column for each fossil sample.
quantiles: numeric; the quantiles of the distribution of the pairwise dissimilarities for the training set for probabilities prob.

Arguments

object: an object of class "analog", usually as a result of a call to analog.
display: character; one or more of the listed choices. Determines which aspects of the analog results are summarised.
k: number of analogues to use. If missing, k is chosen automatically as the k that achieves lowest RMSE.
probs: numeric; giving the probabilities of the distribution to return quantiles for. See quantile.
...: arguments passed to or from other methods.

Author

Gavin L. Simpson

Examples

Run this code

if (FALSE) {
## 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)
}