File: intersect.modal.region.Rd

package info (click to toggle)
r-cran-circular 0.4-93-2
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 1,492 kB
  • sloc: ansic: 463; fortran: 69; sh: 13; makefile: 2
file content (74 lines) | stat: -rw-r--r-- 2,875 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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
\name{intersect.modal.region}
\alias{intersect.modal.region}
\alias{intersect.modal.region.default}
\alias{intersect.modal.region.circular}
  
\title{
  Intersection between model region and a given interval.
}
\description{
Find an estimates of the probability of the intersection between a modal region and a given interval. 
}
\usage{
intersect.modal.region(x, ...)
\method{intersect.modal.region}{default}(x, ...)
\method{intersect.modal.region}{circular}(x, breaks, z = NULL, q = 0.95, bw,
  adjust = 1, type = c("K", "L"), kernel = c("vonmises", "wrappednormal"),
  na.rm = FALSE, step = 0.01, eps.lower = 10^(-4), eps.upper = 10^(-4), ...)  
}
  
\arguments{
  \item{x}{numeric or an object of class \code{\link{circular}}.}
  \item{breaks}{a matrix with two columns. Each row specifies a sub-interval.}
  \item{z}{numeric or object of class \code{\link{circular}}. The grid
    were the kernel density estimate will be evaluated. If \code{NULL}
    equally spaced points in the interval [0,2*pi) with step \code{step}.}
  \item{q}{numeric in the interval [0,1]. The quantile of the modal
    region.} 
  \item{bw}{the smoothing bandwidth to be used. When the \code{kernel}
    is \code{vonmises} the bandwidth is equal to the concentration
    parameter.}
  \item{adjust}{the bandwidth used is actually \code{adjust*bw}. This
    makes it easy to specify values like ``half the default bandwidth''.}
  \item{type}{Not Yet Used.}
  \item{kernel}{a character string giving the smoothing kernel to be
          used. This must be one of \code{"vonmises"} or
      \code{"wrappednormal"}, that are kernels of \code{type} \code{"K"}.}
  \item{na.rm}{logical; if \code{TRUE}, missing values are removed from
    \code{x}. If \code{FALSE} any missing values cause an error.}
  \item{step}{numeric. Used in the construction of the regular grid \code{z}.}
  \item{eps.lower,eps.upper}{the cut point in the density is searched in
   the interval [min(density)*(1+eps.lower),max(density)*(1-eps.upper)].}
  \item{\dots}{further arguments passed to the next methods.}  
}
\details{
Only the version for circular data is actually implemented. 
}
\value{
For the circular method a list with the following three components  
\item{tot}{the total area.}
\item{areas}{information for each subinterval.}
\item{breaks}{the extremes of each subinterval.}
}
\author{
  Claudio Agostinelli
}

\seealso{
\code{\link{modal.region}}
}
\examples{
  x <- rvonmises(100, circular(pi), 10)  
  res <- intersect.modal.region(x, breaks=circular(matrix(c(pi,pi+pi/12,
    pi-pi/12, pi), ncol=2, byrow=TRUE)), bw=50)
  res$tot

  x <- rvonmises(100, circular(0), 10)
  res <- intersect.modal.region(x, breaks=circular(matrix(c(pi,pi+pi/12),
    ncol=2)), bw=50)
  res$tot
  
  res <- intersect.modal.region(x, breaks=circular(matrix(c(pi/12,
    2*pi-pi/12), ncol=2, byrow=TRUE)), bw=50)
  res$tot
}