rangePlot: Create Rangeplot Based On Order Function

View source: R/rangePlot.R

rangePlotR Documentation

Create Rangeplot Based On Order Function

Description

Confidence intervals (CI) consisting of an estimate, upper, and lower limit from Monte-Carlo sampling (given that the statistical hypothesis is true) are arranged according to orderFun and compared with the hypothesized (true) value of the statistic to examine statistical coverage and bias of CI

Usage

rangePlot(
  tf,
  target = "sampleMean",
  orderFun = slug,
  conf = 0.95,
  opacity = 0.2,
  fatten = 0.1,
  title = "Range plot",
  targNum = 1000
)

Arguments

tf

Dataframe with parameter estimate, CI upper and lower limits.

target

scalar, value of statistic under (true) hypothesis, or "sampleMean", default, which calculates the sample mean.

orderFun

one of c(slug, milli, blob), determining the way CI are arranged in the plot

conf

scalar in [0,1], nominal confidence level of simulated CI

opacity

scalar value for alpha

fatten

scalar passed to geom_pointrange

title

character vector for ggtitle

targNum

desired number of lines on graph, for dynamic data thinning

Value

a ggplot object with simulated CI arranged about their target value


dushoff/checkPlots documentation built on Jan. 9, 2025, 11:10 a.m.