summary.randlsp: Summarise Randomised Lomb-Scargle Periodogram Results

View source: R/lspfunctions.R

summary.randlspR Documentation

Summarise Randomised Lomb-Scargle Periodogram Results

Description

Summary method for class randlsp.

Usage

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

Arguments

object

an object of class randlsp.

...

currently, no other arguments are required.

Value

summary.randlsp returns a one column data.frame with results from function randlsp. Row names and contents are as follows:

Time

Name of the sampling time variable.

Data

Name of the measured variable.

Type

either “frequency” or “period”.

Oversampling

The degree of oversampling (>=1).

From

The lowest frequency (or period, depending on type) inspected.

To

The highest frequency (or period, depending on type) inspected.

# frequencies

The number of frequencies (or periods, depending on type) inspected.

PNmax

The peak normalised power in the periodogram.

At frequency

The frequency at which PNmax occurred.

At period

The period at which PNmax occurred.

Repeats

The number of randomisations.

P-value (PNmax)

The probability that PNmax occurred by chance, computed from randomising the data sequence.

Author(s)

Thomas Ruf thomas.ruf@vetmeduni.ac.at

See Also

randlsp

Examples

data(lynx)
summary(randlsp(repeats=500,lynx))

lomb documentation built on March 18, 2022, 7:13 p.m.