summary.circular: Circular Summary Statistics

Description Usage Arguments Details Value Author(s) References See Also Examples

View source: R/summary.circular.R

Description

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

Usage

1
2
3
## 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

1
2
3
4
# 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)))

Example output

Attaching package: 'circular'

The following objects are masked from 'package:stats':

    sd, var

      n    Min. 1st Qu.  Median    Mean 3rd Qu.    Max.     Rho 
50.0000  0.1271  1.2010  1.7490  1.7780  2.4350  3.0880  0.6766 
      data         runif.50..0..pi. 
 n      :50.0000   Min.   :0.03042  
 Min.   : 0.1271   1st Qu.:0.61126  
 1st Qu.: 1.2006   Median :1.51161  
 Median : 1.7488   Mean   :1.52665  
 Mean   : 1.7775   3rd Qu.:2.24243  
 3rd Qu.: 2.4352   Max.   :3.10817  
 Max.   : 3.0878                    
 Rho    : 0.6766                    

circular documentation built on May 1, 2019, 7:57 p.m.