circularp: Attributes for a Circular Object

In apjmason/circular: Circular Statistics

Description

‘circularp’ returns the ‘circularp’ attribute (or ‘NULL’). ‘circularp<-’ sets the ‘circularp’ attribute.

Usage

circularp(x)
circularp(x) <- value

Arguments

x	a vector or a matrix of circular data.
value	a vector of length 6 or a list with six components: type, units, template, modulo, zero and rotation.

Details

The circularp attribute is a list of six elements: type, units, template, modulo, zero and rotation; see circular for their meaning.

Assignments are checked for consistency.

Assigning NULL removes the circularp attribute and any "circular" class of x.

Author(s)

Claudio Agostinelli

See Also

circular

Examples

x <- pi
circularp(x) # now NULL
circularp(x) <- list(type="angles", units="radians", template="none", 
  modulo="asis", zero=0, rotation="counter")
circularp(x)
x
class(x) <- "circular" # now we set also the class so that print.circular is used
x

apjmason/circular documentation built on Dec. 19, 2021, 4:33 a.m.