circularp: Attributes for a Circular Object

Description Usage Arguments Details Author(s) See Also Examples

View source: R/circular.R

Description

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

Usage

1
2
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

1
2
3
4
5
6
7
8
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

Example output

Attaching package: 'circular'

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

    sd, var

NULL
$type
[1] "angles"

$units
[1] "radians"

$template
[1] "none"

$modulo
[1] "asis"

$zero
[1] 0

$rotation
[1] "counter"

[1] 3.141593
attr(,"circularp")
attr(,"circularp")$type
[1] "angles"

attr(,"circularp")$units
[1] "radians"

attr(,"circularp")$template
[1] "none"

attr(,"circularp")$modulo
[1] "asis"

attr(,"circularp")$zero
[1] 0

attr(,"circularp")$rotation
[1] "counter"

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

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