roseMean: Draw mean value in the axis margin

View source: R/print.R

roseMeanR Documentation

Draw mean value in the axis margin

Description

Computes and draws the mean value for a given dataset, may also plot standard error of the mean or standard deviation ranges.

Usage

roseMean(
  input,
  col = c("cornflowerblue", "chartreuse3", "deeppink"),
  mean.length = c(0.0125, -0.0125),
  mean.lwd = 4,
  box.range = c("none", "std.error", "sd"),
  fill = "white",
  horizontal.border = "black",
  vertical.border = "black",
  box.size = c(1.015, 0.985),
  edge.length = c(0.025, -0.025),
  edge.lwd = 2
)

Arguments

input

the input dataset

col

The colours to be used when drawing the means.

mean.length

vertical length of the mean dash.

mean.lwd

width of the mean dash.

box.range

One of "none", "std.error" or "sd", controls the statistic used to draw the range boxes.

fill

Fill colour for the range box.

horizontal.border

Border colour for the horizontal edges of the range box.

vertical.border

Border colour for the vertical edges of the range box.

box.size

Vertical size of the range box.

edge.length

Vertical size of the edge whiskers in the range box.

edge.lwd

Width of the edge whiskers in the range box.

Value

No return value, adds to an existing plot.


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