% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot.R
\name{plot_diagnostic}
\alias{plot_diagnostic}
\alias{plot_diagnostic.brma}
\alias{plot_diagnostic_autocorrelation}
\alias{plot_diagnostic_autocorrelation.brma}
\alias{plot_diagnostic_trace}
\alias{plot_diagnostic_trace.brma}
\alias{plot_diagnostic_density}
\alias{plot_diagnostic_density.brma}
\title{Plot MCMC Diagnostics}
\usage{
plot_diagnostic(x, ...)

\method{plot_diagnostic}{brma}(
  x,
  parameter = NULL,
  parameter_mods = NULL,
  parameter_scale = NULL,
  type,
  plot_type = "base",
  lags = 30,
  ...
)

plot_diagnostic_autocorrelation(x, ...)

\method{plot_diagnostic_autocorrelation}{brma}(
  x,
  parameter = NULL,
  parameter_mods = NULL,
  parameter_scale = NULL,
  type = "autocorrelation",
  plot_type = "base",
  lags = 30,
  ...
)

plot_diagnostic_trace(x, ...)

\method{plot_diagnostic_trace}{brma}(
  x,
  parameter = NULL,
  parameter_mods = NULL,
  parameter_scale = NULL,
  type = "trace",
  plot_type = "base",
  lags = 30,
  ...
)

plot_diagnostic_density(x, ...)

\method{plot_diagnostic_density}{brma}(
  x,
  parameter = NULL,
  parameter_mods = NULL,
  parameter_scale = NULL,
  type = "density",
  plot_type = "base",
  lags = 30,
  ...
)
}
\arguments{
\item{x}{a fitted brma object}

\item{...}{additional graphical arguments passed through RoBMA's diagnostic
setup to \code{BayesTools::JAGS_diagnostics()}.}

\item{parameter}{base parameter to plot. Defaults to \code{NULL}, which uses
\code{"mu"} or the meta-regression intercept. Valid values include
\code{"mu"}, \code{"tau"}, \code{"rho"}, \code{"PET"}, \code{"PEESE"},
and \code{"omega"} or \code{"weightfunction"} when present.}

\item{parameter_mods}{moderator term for location regression.}

\item{parameter_scale}{term for scale regression.}

\item{type}{diagnostic plot type. Convenience wrappers set a type-specific
default but still forward this argument to \code{plot_diagnostic.brma()}.}

\item{plot_type}{whether to use a base plot \code{"base"} or ggplot2
\code{"ggplot"} for plotting. Defaults to \code{"base"}.}

\item{lags}{number of lags for autocorrelation plots. Defaults to 30.}
}
\value{
\code{plot_diagnostic} returns the object returned by
\code{BayesTools::JAGS_diagnostics()}, invisibly for base graphics.
}
\description{
\code{plot_diagnostic} creates visual MCMC diagnostics for a
fitted brma object. Convenience wrappers are available for trace, density,
and autocorrelation plots.
}
\seealso{
\code{\link[=summary.brma]{summary.brma()}}
}
