plotLRR: Plot local range ratios

View source: R/plotLRR.R

plotLRRR Documentation

Plot local range ratios

Description

Plot local range ratios

Usage

plotLRR(
  E,
  U,
  ordX = NULL,
  logX = FALSE,
  prob = c(0.95),
  nBin = NULL,
  equiPop = TRUE,
  popMin = 30,
  logBin = TRUE,
  intrv = NULL,
  plot = TRUE,
  slide = FALSE,
  mycols = 1:length(prob),
  xlab = "Calculated value",
  xlim = NULL,
  ylim = NULL,
  title = "",
  legend = paste0("P", round(100 * prob)),
  legLoc = "bottom",
  legNcol = 3,
  add = FALSE,
  label = 0,
  gPars = ErrViewLib::setgPars()
)

Arguments

E

(vector) Errors

U

(matrix) Prediction uncertainties

ordX

(vector) set of abscissas to order sample

logX

(logical) log-transform abscissas

prob

(vector) a set of coverage probabilities for the PUs

nBin

(integer) number of intervals for local coverage stats

equiPop

(logical) generate intervals with equal bin counts (default: 'equiPop = TRUE')

popMin

(integer) minimal bin count in an interval

logBin

(logical) if 'equiPop = FALSE', one can choose between equal range intervals, or equal log-range intervals (default 'logBin = TRUE')

intrv

(object) intervals generated by 'genIntervals' (default: 'NULL')

plot

(logical) plot the results

slide

(logical) use sliding window

mycols

(vector) a set of color indexes to gPars colors

xlab

(string) abscissa label

xlim

(vector) range for abscissa

ylim

(vector) limits of the y axis

title

(string) a title to display above the plot

legend

(string) legend for the dataset

legLoc

(string) location of legend (see xy.coord)

legNcol

(integer) number of columns for legend

add

(logical) add to previous graph ?

label

(integer) index of letter for subplot tag

gPars

(list) graphical parameters

Value

Invisibly returns a list of LCP results. Mainly used for its plotting side effect.

Examples


  uE  = sqrt(rchisq(1000, df = 4))  # Re-scale uncertainty
  E   = rnorm(uE, mean=0, sd=uE)    # Generate errors
  plotLRR(E, 1.96*uE, ordX = uE, xlab = 'Uncertainty, uE', ylim = c(0,2))


ppernot/ErrViewLib documentation built on June 1, 2024, 4:33 a.m.