File: mle.wrappedcauchy.Rd

package info (click to toggle)
r-cran-circular 0.4-93-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,492 kB
  • sloc: ansic: 463; fortran: 69; sh: 13; makefile: 2
file content (58 lines) | stat: -rw-r--r-- 1,950 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
49
50
51
52
53
54
55
56
57
58
\name{mle.wrappedcauchy}
\title{Wrapped Cauchy Maximum Likelihood Estimates}
\alias{mle.wrappedcauchy}
\alias{print.mle.wrappedcauchy}

\description{
Computes the maximum likelihood estimates for the parameters of a
Wrapped Cauchy distribution:  mean and concentration parameter.
}

\usage{
mle.wrappedcauchy(x, mu = NULL, rho = NULL, tol = 1e-15, 
        max.iter = 100, control.circular = list())
\method{print}{mle.wrappedcauchy}(x, digits = max(3, getOption("digits") - 3), \dots)
}

\arguments{
  \item{x}{a vector. The object is coerced to class
    \code{\link{circular}}.}
  \item{mu}{if \code{NULL} the maximum likelihood estimate of the mean
    direction is calculated otherwise it is coerced to an object of class \code{circular}.}
  \item{rho}{if \code{NULL} the maximum likelihood estimate of the
    concentration parameter is calculated.}
  \item{tol}{precision of the estimation.}
  \item{max.iter}{maximum number of iterations.}
  \item{control.circular}{the attribute of the resulting objects (\code{mu})}
  \item{digits}{integer indicating the precision to be used.}
  \item{\dots}{further arguments passed to or from other methods.}
 }

\value{
  Returns a list with the following components:

  \item{call}{the \code{\link[base]{match.call}} result.}
  \item{mu}{the estimate of the mean direction or the value supplied as an object of class \code{circular}.}
  \item{rho}{the estimate of the concentration parameter or the
    value supplied}
  \item{convergence}{TRUE if convergence is achieved.}
}

\author{Claudio Agostinelli and Ulric Lund}

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

\seealso{
\code{\link{mean.circular}}
}

\examples{
x <- rwrappedcauchy(n=50, mu=circular(0), rho=0.5)
mle.wrappedcauchy(x) # estimation of mu and rho
mle.wrappedcauchy(x, mu=circular(0)) # estimation of rho only
}

\keyword{htest}