R: Sample Circular Quantiles

quantile.circular {circular} | R Documentation

## Sample Circular Quantiles

### Description

The function `quantile.circular` produces sample circular quantiles corresponding to the given probabilities for a circular data set.

### Usage

    ## S3 method for class 'circular'
    quantile(x, probs = seq(0, 1, 0.25), na.rm=FALSE, names = TRUE, type = 7, ...)

### Arguments

`x` | numeric circular vector whose sample quantiles are wanted. `NA` and `NaN` values are not allowed in numeric vectors unless `na.rm` is `TRUE`.
`probs` | numeric vector of probabilities with values in [0,1]. (Values up to 2e-14 outside that range are accepted and moved to the nearby endpoint.)
`na.rm` | logical; if true, any `NA` and `NaN`'s are removed from `x` before the quantiles are computed.
`names` | logical; if true, the result has a `names` attribute. Set to `FALSE` for speedup with many `probs`.
`type` | an integer between 1 and 9 selecting one of the nine quantile algorithms detailed below to be used.
`...` | further arguments passed to or from other methods. Like `quantile` and so on.

### Details

A vector of length `length(probs)` is returned; if `names = TRUE`, it has a `names` attribute.

`NA` and `NaN` values in `probs` are propagated to the result.

The algorithm will proceed how described below: 1) Linearize the circular observations. 2) Calulate the linear median like type establish. 3) The value it will transformed in circular.

### Types

See description on documentation of `quantile`.

### Author(s)

Claudio Agostinelli and Alessandro Gagliardi.

### Examples

    x <- rvonmises(1001, mu=circular(pi), kappa=5)
    quantile.circular(x) # Extremes & Quartiles by default

[Package circular version 0.4-93 Index]