Circular {circular}R Documentation

Create Objects of class circular for Circular data.

Description

The function circular is used to create circular objects. as.circular and is.circular coerce an object to a circular and test whether an object is a circular data.

Usage

circular(x, type = c("angles", "directions"), units = c("radians", "degrees"), template = c("none", "geographics"), modulo = c("asis", "2pi", "pi"), zero = 0, rotation = c("counter", "clock"), names)
as.circular(x, ...)
is.circular(x)
## S3 method for class 'circular':
print(x, info=TRUE, ...)

Arguments

x a vector or a matrix.
type the type of measures (Not Used Yet).
units units of the measures.
template how the data should be plotted (Until now only 'geographics' style is available).
modulo if we need to reduce the measures to modulo.
zero the zero of the axes (in radians).
rotation the orientation of the axes.
names names of the data.
info if TRUE information on the properties of the data are printed.
... parameters passed to circular for as.circular and to print.default for print.circular.

Value

an object of class circular

Author(s)

Claudio Agostinelli

Examples

x <- circular(c(pi, pi/3, pi/4))
print(x)
is.circular(x)

[Package circular version 0.3-2 Index]