copyOfCirclePlotRad: circular:::circlePlotRad

In actel: Acoustic Telemetry Data Analysis

circular:::circlePlotRad

Description

This function is an EXACT copy of the function circlePlotRad() 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

copyOfCirclePlotRad(
  xlim = c(-1, 1),
  ylim = c(-1, 1),
  uin = NULL,
  shrink = 1,
  tol = 0.04,
  main = NULL,
  sub = NULL,
  xlab = NULL,
  ylab = NULL,
  control.circle = circular::circle.control()
)

Arguments

xlim, ylim	the ranges to be encompassed by the x and y axes. Useful for centring the plot.
uin	desired values for the units per inch parameter. If of length 1, the desired units per inch on the x axis.
shrink	parameter that controls the size of the plotted circle. Default is 1. Larger values shrink the circle, while smaller values enlarge the circle.
tol	proportion of white space at the margins of plot.
main, sub, xlab, ylab	title, subtitle, x label and y label of the plot.
control.circle	parameters passed to plot.default in order to draw the circle. The function circle.control is used to set the parameters.

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.