copyOfRosediagRad: circular:::RosediagRad

In actel: Acoustic Telemetry Data Analysis

circular:::RosediagRad

Description

This function is an EXACT copy of the function RosediagRad() in the circular package. As the function is not exported by the original package, I have copied it here to resolve the note thrown by devtools::check()

Usage

copyOfRosediagRad(
  x,
  zero,
  rotation,
  bins,
  upper,
  radii.scale,
  prop,
  border,
  col,
  ...
)

Arguments

x	a vector, matrix or data.frame. The object is coerced to class circular.
zero	the zero of the plot. Ignored if plot.info or template are provided.
rotation	the rotation of the plot. Ignored if plot.info or template are provided.
bins	number of arcs to partition the circle with.
upper	logical: if TRUE, the rose diagram cells are "upper"-closed intervals.
radii.scale	make possible to choose sector radius form: square-root of relative frequency (sqrt, default) or conventional linear scale (linear).
prop	numerical constant determining the radii of the sectors. By default, prop = 1.
border	the colour to draw the border. The default, NULL, means to use par("fg"). Use border = NA to omit borders.
col	the colour for filling the rose diagram. The default, NULL, is to leave rose diagram unfilled. The values are recycled if needed.

Details

For more details about the original function, visit the circular package homepage at https://github.com/cran/circular

Value

No return value, adds to an existing plot.

actel documentation built on Oct. 19, 2023, 9:08 a.m.