plot_pi: Show a diagnosis plot of pi

View source: R/plots.R

plot_piR Documentation

Show a diagnosis plot of pi

Description

Show a diagnosis plot of pi

Usage

plot_pi(
  x,
  show_topic = NULL,
  start = 0,
  ci = 0.9,
  method = c("hdi", "eti"),
  point = c("mean", "median")
)

Arguments

x

the output from a keyATM model (see keyATM()).

show_topic

an integer or a vector. Indicate topics to visualize. Default is NULL.

start

integer. The starting value of iteration to use in the plot. Default is 0.

ci

value of the credible interval (between 0 and 1) to be estimated. Default is 0.9 (90%). This is an option when calculating credible intervals (you need to set store_pi = TRUE in keyATM()).

method

method for computing the credible interval. The Highest Density Interval (hdi, default) or Equal-tailed Interval (eti). This is an option when calculating credible intervals (you need to set store_pi = TRUE in keyATM()).

point

method for computing the point estimate. mean (default) or median. This is an option when calculating credible intervals (you need to set store_pi = TRUE in keyATM()).

Value

keyATM_fig object.

See Also

save_fig()


keyATM documentation built on May 31, 2023, 6:27 p.m.