s.curve.plot: Plotting tool for specification curve output from s.curve

Description Usage Arguments Value

View source: R/s.curve.plot.R

Description

Plotting tool for specification curve output from s.curve

Usage

1
2
3
4
s.curve.plot(s.curve.mod, what = "estimate", title = NULL,
  plot.order = NULL, decreasing = TRUE, show.sig = TRUE,
  include.permutations = FALSE, perm.sig = FALSE, pointsize = 2,
  x.alt = NULL, plot.theme = NULL)

Arguments

s.curve.mod

fitted model object from function s.curve() or s.curve.update()

what

character, for each specification, what result is to be plotted? Accepts "estimate" (treatment estimate, default), "p.value", "perm.p.value" (permutation-test-estimated p-value), "AIC", "BIC"

title

character, what should the title of the plot be?

plot.order

character - what, if anything, should the values be sorted on? Accepts same values as estimate "parameter"

decreasing

logical, when sorting, use decreasing order (default TRUE)

show.sig

logical, should the points be colorized by significance? (default TRUE)

include.permutations

logical, if permutations are present, include CI boundaries of permutations? (default FALSE)

perm.sig

logical, use permutation p-values for significance markings? (default FALSE)

pointsize

numeric, size of points to use in plotting (default 2)

x.alt

numeric vector, with same length as # specifications. If included, manually positions specifications

plot.theme

character, name of theme available to ggplot to override default (e.g. "minimal", "bw", "classic")

Value

a ggplot plot summarizing the results of the fitted s.curve object passed to it. Can be saved, or will render plot in viewer if printed to console.


jmobrien/SpecCurve documentation built on Feb. 12, 2020, 11:35 a.m.