plot_summary: Plot summary functions

View source: R/rapt_summarize.R

plot_summaryR Documentation

Plot summary functions

Description

Plot the observed value with envelopes for expected values for summary function

Usage

plot_summary(
  func = "K",
  observed_values,
  envelopes,
  ...,
  pattern.colors = c(`95.0% AI` = "pink", Median = "black", Observed = "blue"),
  fill.colors = pattern.colors,
  unit = "nm",
  K_cor = "trans",
  G_cor = "km",
  F_cor = "km",
  GXGH_cor = "km",
  GXHG_cor = "km"
)

Arguments

func

Summary function to plot

observed_values

observed summary function value

envelopes

theoretical values found by function such as calc_summary_funcs(). Should be list

pattern.colors

colors and names for envelope lines

fill.colors

colors and names for envelope fill. Match names to pattern.colors

K_cor

edge correction(s) to be used for K function

G_cor

edge correction(s) to be used for G function

F_cor

edge correction(s) to be used for F function

GXGH_cor

edge correction(s) to be used for GXGH function

GXHG_cor

edge correction(s) to be used for GXHG function


aproudian2/rapt documentation built on Dec. 15, 2022, 4:24 a.m.