isocir {isocir} | R Documentation |
S3 Objects of Class isocir.
Description
This function creates an S3 object of class isocir
. There are also some methods described for the class isocir
.
Usage
isocir(cirmeans = NULL, SCE =NULL, CIRE = NULL, pvalue = NULL, kappa = NULL)
is.isocir(x)
## S3 method for class 'isocir'
print(x, decCIRE = 3, decpvalue = 4, deckappa = 2, ...)
Arguments
cirmeans |
NULL by default, the unrestricted circular means |
SCE |
NULL by default, the Sum of Circular Errors. |
CIRE |
NULL by default, the Circular Isotonic Regression Estimator. |
pvalue |
NULL by default, the result of the conditional test |
kappa |
NULL by default. |
x |
an object of class CIRE. |
decCIRE |
the number of decimal places to round the CIRE and the SCE. |
decpvalue |
the number of decimal places to round the pvalue. |
deckappa |
the number of decimal places to round kappa. |
... |
futher parameters passed to |
Details
With the function isocir
a list of class isocir
is created with the elements: cirmeans
, SCE
, CIRE
even if they are NULL. However, pvalue
and kappa
are added just in the case that they have any value.
The argument x
must be of class isocir
.
Value
An object of class isocir
.
Author(s)
Sandra Barragán.
See Also
Examples
data(cirdata)
x <- CIRE(cirdata)
print(x)
is.isocir(x)
class(x)
plot(x)
class(x)
# If you want to use the CIRE in other calculations you can obtain it as a vector:
unlist(x$CIRE)
# But be careful because this unclass and lost attributes!
# To create a new object of class CIRE:
y <- isocir()