summary.SpdPermTest: Summarise a 'SpdPermTest' class object

View source: R/tests.R

summary.SpdPermTestR Documentation

Summarise a SpdPermTest class object

Description

summary method for class "SpdPermTest"

Usage

## S3 method for class 'SpdPermTest'
summary(object, type = "spd", ...)

Arguments

object

A SpdPermTest class object produced using the link{permTest} function.

type

Specifies whether the summary should be based on SPD ('spd') or associated rates of change ('roc'). Default is 'spd'.

...

Ignored

Details

The summary function returns metadata (number of radiocarbon dates, bins, and simulations), the p-value of the global significance test, and the chronological interval of local positive and negative deviations from the simulation envelope for each set.

See Also

permTest.


ahb108/rcarbon documentation built on Aug. 29, 2023, 9:21 a.m.