range.circular: Circular Range

Description Usage Arguments Details Value Author(s) References See Also Examples

View source: R/range.circular.R

Description

Computes the circular range of a data set and performs a test of uniformity if specified.

Usage

1
2
3
## S3 method for class 'circular'
range(x, test=FALSE, na.rm = FALSE, finite = FALSE, 
  control.circular=list(), ...)

Arguments

x

a vector. The object is coerced to class circular.

test

logical flag: if TRUE then the test of uniformity is performed; otherwise the test is not performed. Default is FALSE.

na.rm

logical, indicating if NA's should be omitted.

finite

logical, indicating if all non-finite elements should be omitted.

control.circular

the attribute of the resulting object.

...

further parameter passed from/to the method.

Details

The circular range is the shortest arc on the circle containing the entire set of data. The p-value is computed using the exact distribution of the circular range under the hypothesis of uniformity, details can be found in Mardia and Jupp (1999) pag. 107.

Value

Returns the circular range as a circular object. If the significance test is requested the p-value of the test is returned as p.value.

Author(s)

Claudio Agostinelli and Ulric Lund

References

K.V. Mardia and P.E. Jupp (1999) Directional Statistics, Wiley.

See Also

kuiper.test, rao.spacing.test, rayleigh.test and watson.test.

Examples

1
2
3
4
data <- rvonmises(n=50, mu=circular(0), kappa=2)
range(data, test=TRUE)
data <- circular(runif(50, 0, 2*pi))
range(data, test=TRUE)

Example output

Attaching package: 'circular'

The following objects are masked from 'package:stats':

    sd, var

$range
Circular Data: 
Type = angles 
Units = radians 
Template = none 
Modulo = asis 
Zero = 0 
Rotation = counter 
[1] 5.048632

$p.value
[1] 0.001105753

$range
Circular Data: 
Type = angles 
Units = radians 
Template = none 
Modulo = asis 
Zero = 0 
Rotation = counter 
[1] 5.778068

$p.value
[1] 0.6201917

circular documentation built on May 1, 2019, 7:57 p.m.