File: asselin.Rd

package info (click to toggle)
r-cran-modeest 2.4.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 280 kB
  • sloc: makefile: 2
file content (51 lines) | stat: -rw-r--r-- 1,213 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/asselin.R
\name{asselin}
\alias{asselin}
\alias{Asselin}
\title{The Asselin de Beauville mode estimator}
\usage{
asselin(x, bw = NULL, ...)
}
\arguments{
\item{x}{numeric. Vector of observations.}

\item{bw}{numeric. A number in \code{(0, 1]}. 
If \code{bw = 1}, the selected 'modal chain' may be too long.}

\item{...}{further arguments to be passed to the \code{\link[stats]{quantile}} function.}
}
\value{
A numeric value is returned, the mode estimate.
}
\description{
This mode estimator is based on the algorithm 
described in Asselin de Beauville (1978).
}
\note{
The user may call \code{asselin} through 
\code{mlv(x, method = "asselin", ...)}.
}
\examples{
x <- rbeta(1000, shape1 = 2, shape2 = 5)

## True mode:
betaMode(shape1 = 2, shape2 = 5)

## Estimation:
asselin(x, bw = 1)
asselin(x, bw = 1/2)
mlv(x, method = "asselin")

}
\references{
\itemize{
  \item Asselin de Beauville J.-P. (1978). 
  Estimation non parametrique de la densite et du mode, 
  exemple de la distribution Gamma. 
  \emph{Revue de Statistique Appliquee}, \bold{26}(3):47-70.
}
}
\seealso{
\code{\link[modeest]{mlv}} for general mode estimation.
}