summary.circular: Circular Summary Statistics

View source: R/summary.circular.R

summary.circularR Documentation

Circular Summary Statistics

Description

Computes circular summary statistics including the sample size, mean direction and mean resultant length and quartiles.

Usage

## S3 method for class 'circular'
summary(object,
   digits = max(3, getOption("digits") - 3), ...)

Arguments

object

an object of class circular.

digits

digits to be used in printing.

...

parameters passed to summary.matrix if needed.

Details

Each observation is treated as a unit vector or a point on the unit circle. The resultant vector of the observations is found, and the direction of the resultant vector is returned as well as its length divided by the sample size.

Value

Returns a vector with the sample size, the sample mean direction and the sample mean resultant length.

Author(s)

Claudio Agostinelli, David Andel and Alessandro Gagliardi

References

Jammalamadaka, S. Rao and SenGupta, A. (2001). Topics in Circular Statistics, Section 1.3, World Scientific Press, Singapore.

See Also

mean.circular, median.circular, quantile.circular, var.circular, mle.vonmises, rho.circular.

Examples

# Compute summary statistics of a random sample of observations. 
data <- circular(runif(50, 0, pi))
summary(data)
summary(data.frame(data, runif(50, 0, pi)))

circular documentation built on Sept. 11, 2024, 8:21 p.m.