1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
\name{circularp}
\alias{circularp}
\alias{circularp<-}
\title{Attributes for a Circular Object}
\description{
`circularp' returns the `circularp' attribute (or `NULL'). `circularp<-' sets the `circularp' attribute.
}
\usage{
circularp(x)
circularp(x) <- value
}
\arguments{
\item{x}{a vector or a matrix of circular data.}
\item{value}{a vector of length 6 or a list with six components: type, units,
template, modulo, zero and rotation.}
}
\details{
The \code{circularp} attribute is a list of six elements: type, units,
template, modulo, zero and rotation; see \code{\link{circular}} for
their meaning.
Assignments are checked for consistency.
Assigning \code{NULL} removes the \code{circularp} attribute
and any \code{"circular"} class of \code{x}.
}
\author{Claudio Agostinelli}
\seealso{\code{\link{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
}
\keyword{misc }
|
