File: var.circular.Rd

package info (click to toggle)
r-cran-circular 0.5-1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,492 kB
  • sloc: ansic: 464; fortran: 69; sh: 13; makefile: 2
file content (46 lines) | stat: -rw-r--r-- 1,206 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
\name{var.circular}
\title{A measure of variance for Circular Data}
\alias{var.circular}

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

\usage{
\method{var}{circular}(x, na.rm = FALSE, \dots)
}

\arguments{
  \item{x}{a vector. The object is coerced to class
    \code{\link{circular}}.}
  \item{na.rm}{logical, indicating if \code{\link{NA}}'s should be
    omitted.}
  \item{\dots}{further arguments passed to or from other methods.}
}


\value{
Returns one minus the mean resultant length divided by the sample size of data.
}

\author{Claudio Agostinelli and Ulric Lund}

\references{
Mardia, K.V. (1972) Statistics of Directional Data. Academic Press, London. 

Fisher, N.I. (1993) Statistical analysis of circular data. Cambridge
University Press.

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

\seealso{
\code{\link{sd.circular}}, \code{\link{angular.variance}}, \code{\link{mean.circular}}, \code{\link{rho.circular}} and \code{\link{summary.circular}}.
}

\examples{
x <- rvonmises(n=100, mu=circular(0), kappa=1)
var(x)
}

\keyword{univar}