% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utilities.R
\name{RoBMA_options}
\alias{RoBMA_options}
\alias{RoBMA.options}
\alias{RoBMA.get_option}
\title{Options for the RoBMA package}
\usage{
RoBMA.options(...)

RoBMA.get_option(name)
}
\arguments{
\item{...}{named option(s) to change. Names must be exact public option names,
nonempty, and unique.}

\item{name}{a single non-missing character string matching one public option
exactly; for available options, see details below.}
}
\value{
\code{RoBMA.options()} invisibly returns a named list with all current
options after applying any changes. \code{RoBMA.get_option()} returns the current
value of the requested option.
}
\description{
Inspect or change package-level defaults used by RoBMA.
}
\details{
The available options are:
\describe{
\item{\code{max_cores}}{number of cores to use for parallel computing (default is one fewer than detected logical cores, with a minimum/fallback of 1)}
\item{\code{check_scaling}}{whether to check scaling of predictors (default \code{TRUE})}
\item{\code{silent}}{whether to suppress output (default \code{FALSE})}
\item{\code{autocompute.loo}}{whether to automatically compute LOO (default \code{FALSE})}
\item{\code{autocompute.waic}}{whether to automatically compute WAIC (default \code{FALSE})}
\item{\code{autocompute.marglik}}{whether to automatically compute marginal likelihood (default \code{FALSE})}
\item{\code{cluster_likelihood.n_gamma}}{number of Gauss-Hermite nodes used for cluster-unit log-likelihoods (default \code{15})}
\item{\code{default_UISD.effect}}{default scaling of the unit information standard deviation for the effect size parameter (default \code{0.5})}
\item{\code{default_UISD.heterogeneity}}{default scaling of the unit information standard deviation for the heterogeneity parameter (default \code{0.25})}
\item{\code{default_UISD.mods}}{default scaling of the unit information standard deviation for the moderators (default \code{0.25})}
\item{\code{default_UISD.scale}}{default scaling of the unit information standard deviation for the scale parameter (default \code{0.5})}
\item{\code{default_informed_priors.mods}}{default scaling of informed priors for moderators (default \code{0.5})}
\item{\code{default_informed_priors.scale}}{default scaling of informed priors for the scale parameter (default \code{0.5})}
\item{\code{default_bias_weightfunction.alpha}}{default alpha for the weightfunction (default \code{1})}
\item{\code{default_bias_PET.scale}}{default scale for the PET (default \code{1})}
\item{\code{default_bias_PEESE.scale}}{default scale for the PEESE (default \code{5})}
}

Boolean options require scalar \code{TRUE} or \code{FALSE} values.
\code{max_cores} must be integer-like and at least 1;
\code{cluster_likelihood.n_gamma} must be integer-like and at least 3.
Scale and alpha defaults must be finite positive numbers.
}
