Learn R Programming

circular (version 0.3-1)

var.circular: A measure of variance for Circular Data

Description

Returns one minus the mean resultant length divided by the sample size of a vector of circular data.

Usage

## S3 method for class 'circular':
var(x, na.rm = FALSE, only.var = TRUE, \dots)

Arguments

x
a vector. The object is coerced to class circular.
na.rm
logical, indicating if NA's should be omitted.
only.var
logical, if FALSE the mean result length is reported as well.
...
further arguments passed to or from other methods.

Value

  • Returns one minus the mean resultant length divided by the sample size of data if only.var is TRUE, otherwise a vector with the following components: the number of observations, the mean resultant length, the mean resultant length divided by the sample size, and one minus the mean resultant length divided by the sample size.

References

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

See Also

mean.circular, rho.circular and summary.circular.

Examples

Run this code
# Compute the mean resultant length of a random sample of observations.
x <- rvonmises(n=100, mu=0, kappa=1)
var(x)

Run the code above in your browser using DataLab