plotValues: Test for and Plot Errors in Acoustic Survey Values

Description Usage Arguments Value

View source: R/plotValues.R

Description

Test for and plot errors in acoustic survey data, based on reported lows, highs, and in-between values.

Usage

1
2
3
4
5
6
7
8
9
plotValues(
  low,
  high,
  between,
  lowhighKnown = FALSE,
  varname = "Varname",
  test = FALSE,
  ...
)

Arguments

low

A numeric vector of low values.

high

A numeric vector of high values, the same length as low.

between

A numeric vector of in between values, the same length as low.

lowhighKnown

A logical scalar indicating whether the vector representing the lows and the vector representing the highs are known, default FALSE. If FALSE, the low (and high) value is calculated as the elementwise minimum (and maximum) of the three vectors, low, high, and between.

varname

A character scalar identifying what the values represent, used as the y-axis label if test=FALSE, default "Varname".

test

A logical scalar indicating whether to conduct a test for errors (TRUE) or to draw a plot of the results (FALSE, the default).

...

Additional arguments to plot.

Value

If test = TRUE, a logical scalar is returned indicating whether there were errors in the values (TRUE) or not (FALSE). If test = FALSE, a figure is drawn, but no value is returned.


JVAdams/EchoNet2Fish documentation built on Feb. 15, 2021, 4:27 a.m.