R: Summary for a Cosinor

summary.Cosinor {season}

R Documentation

Summary for a Cosinor

Description

The default print method for a Cosinor object produced by cosinor.

Usage

## S3 method for class 'Cosinor'
summary(object, digits = 2, ...)

Arguments

`object`	a `Cosinor` object produced by `cosinor`.
`digits`	minimal number of significant digits, see `print.default`
`...`	further arguments passed to or from other methods.

Details

Summarises the sinusoidal seasonal pattern and tests whether there is statistically significant seasonal or circadian pattern (assuming a smooth sinusoidal pattern). The amplitude describes the average height of the sinusoid, and the phase describes the location of the peak. The scale of the amplitude depends on the link function. For logistic regression the amplitude is given on a probability scale. For Poisson regression the amplitude is given on an absolute scale.

Value

`n`	sample size.
`amp`	estimated amplitude.
`amp.scale`	the scale of the estimated amplitude (empty for standard regression; ‘probability scale’ for logistic regession; ‘absolute scale’ for Poisson regression).
`phase`	estimated peak phase on a time scale.
`lphase`	estimated low phase on a time scale (half a year after/before `phase`).
`significant`	statistically significant sinusoid (TRUE/FALSE).
`alpha`	statistical significance level.
`digits`	minimal number of significant digits.
`text`	add explanatory text to the returned phase value (TRUE) or return a number (FALSE).
`type`	type of data (yearly/monthly/weekly/hourly).
`ctable`	table of regression coefficients.

Author(s)

Adrian Barnett a.barnett@qut.edu.au