File: meandeviation.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 (48 lines) | stat: -rw-r--r-- 1,238 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
47
48
\name{meandeviation}
\title{A measure of deviation for Circular Data}
\alias{meandeviation}

\description{
Returns a measure of spread associated with the circular median of a vector of circular data.
}

\usage{
meandeviation(x, na.rm = FALSE)
}

\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.}
}

\details{
See equation (2.33) at pag. 36 in Fisher (1993)
for its definition. In the case the circular median is not defined, that
is, every angle is a median axis, the mean deviation is not reported and
set to \code{NA}.
}

\value{
Returns a measure of spread associated with the circular median of a
vector of circular data.
}

\author{Claudio Agostinelli and Alessandro Gagliardi}

\references{
  N.I. Fisher (1993) Statistical Analysis of Circular Data, Cambridge
  University Press.
}

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

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

\keyword{univar}