AxialBoxplot {bpDir} | R Documentation |
AxialBoxplot
Description
Draw a boxplot for axial data
Usage
AxialBoxplot(A, template = "degrees", place = "none", marg =
"large", stack = FALSE, H = FALSE, shrink = 1.5, units
= "degrees", constant = "optimal", mirror = TRUE)
Arguments
A |
numeric; a vector of class circular in |
template |
character; graphical parameter to set the template to be used in the plot. Options are |
place |
character; graphical parameter. Active only when |
marg |
character; graphical parameter to set the plot region to either |
stack |
If |
H |
logical; graphical parameter to specify if observations between the hinges and the whiskers are plotted. Default is |
shrink |
numeric; graphical parameter to control the size of the plotted circle. Default is 1.5. Larger values shrink the circle, while smaller values enlarge the circle. |
units |
character; graphical parameter to select the unit of measure to be displayed on the axes when |
constant |
numeric; the boxplot multiplying factor (or "constant") that determines how far the fences extend out from the box. When |
mirror |
If |
Details
The arguments stack
, shrink
are parameters passed to plot.circular.
Value
farout |
a vector of class circular in radians, containing the values of the points lying outside the whiskers. |
constant |
the value of the constant used to draw the boxplot. |
Author(s)
Davide Buttarazzi
References
Buttarazzi D., Pandolfo G., Porzio G.C. (2018). A boxplot for circular data, Biometrics.
Examples
set.seed(1)
#install.packages("circular")
require(circular)
#install.packages("plotrix")
require(plotrix)
theta <- circular::rvonmises(100, circular(pi/2), 3, control.circular=list(units="radians"))
axialTheta <- circular(theta, modulo = "pi")
AxialBoxplot(axialTheta, template = "radians", mirror = FALSE)