diff --git a/R/bayesplot-ggplot-themes.R b/R/bayesplot-ggplot-themes.R index fb7c5bed..a817b834 100644 --- a/R/bayesplot-ggplot-themes.R +++ b/R/bayesplot-ggplot-themes.R @@ -2,13 +2,14 @@ #' #' The [theme_default()] function returns the default ggplot #' [theme][ggplot2::theme] used by the **bayesplot** plotting functions. See -#' [bayesplot_theme_set()] for details on setting and updating the plotting theme. +#' [bayesplot_theme_set()] for details on setting and updating the plotting +#' theme. #' #' @export #' @param base_size,base_family Base font size and family (passed to #' [ggplot2::theme_bw()]). It is possible to set `"bayesplot.base_size"` and -#' `"bayesplot.base_family"` via [options()] to change the defaults, w -#' hich are `12` and `"serif"`, respectively. +#' `"bayesplot.base_family"` via [options()] to change the defaults, which are +#' `12` and `"serif"`, respectively. #' @return A ggplot [theme][ggplot2::theme] object. #' #' @seealso [bayesplot_theme_set()] to change the ggplot theme. diff --git a/R/mcmc-diagnostics-nuts.R b/R/mcmc-diagnostics-nuts.R index 8023a238..471c20a4 100644 --- a/R/mcmc-diagnostics-nuts.R +++ b/R/mcmc-diagnostics-nuts.R @@ -1,7 +1,8 @@ #' Diagnostic plots for the No-U-Turn-Sampler (NUTS) #' #' Diagnostic plots for the No-U-Turn-Sampler (NUTS), the default MCMC algorithm -#' used by [Stan](https://mc-stan.org). See the **Plot Descriptions** section, below. +#' used by [Stan](https://mc-stan.org). See the **Plot Descriptions** section, +#' below. #' #' @name MCMC-nuts #' @aliases NUTS @@ -55,7 +56,8 @@ #' \item{`mcmc_nuts_divergence()`}{ #' Two plots: #' * Violin plots of `lp__|divergent__=1` and `lp__|divergent__=0`. -#' * Violin plots of `accept_stat__|divergent__=1` and `accept_stat__|divergent__=0`. +#' * Violin plots of `accept_stat__|divergent__=1` and +#' `accept_stat__|divergent__=0`. #' } #' #' \item{`mcmc_nuts_stepsize()`}{ @@ -89,7 +91,7 @@ #' * [mcmc_trace()]: show divergences as tick marks below the #' trace plot. #' * [mcmc_parcoord()]: change the color/size/transparency of lines -#' correspondending to divergences. +#' corresponding to divergences. #' * [mcmc_scatter()]: change the color/size/shape of points #' corresponding to divergences. #' * [mcmc_pairs()]: change the color/size/shape of points diff --git a/man/MCMC-nuts.Rd b/man/MCMC-nuts.Rd index 62387f4a..ed455c91 100644 --- a/man/MCMC-nuts.Rd +++ b/man/MCMC-nuts.Rd @@ -57,7 +57,8 @@ except for \code{mcmc_nuts_energy()}, which returns a ggplot object. } \description{ Diagnostic plots for the No-U-Turn-Sampler (NUTS), the default MCMC algorithm -used by \href{https://mc-stan.org}{Stan}. See the \strong{Plot Descriptions} section, below. +used by \href{https://mc-stan.org}{Stan}. See the \strong{Plot Descriptions} section, +below. } \section{Quick Definitions}{ @@ -96,7 +97,8 @@ lines indicating the mean (solid line) and median (dashed line). Two plots: \itemize{ \item Violin plots of \code{lp__|divergent__=1} and \code{lp__|divergent__=0}. -\item Violin plots of \code{accept_stat__|divergent__=1} and \code{accept_stat__|divergent__=0}. +\item Violin plots of \code{accept_stat__|divergent__=1} and +\code{accept_stat__|divergent__=0}. } } @@ -175,7 +177,7 @@ extra arguments if the model was fit using NUTS: \item \code{\link[=mcmc_trace]{mcmc_trace()}}: show divergences as tick marks below the trace plot. \item \code{\link[=mcmc_parcoord]{mcmc_parcoord()}}: change the color/size/transparency of lines -correspondending to divergences. +corresponding to divergences. \item \code{\link[=mcmc_scatter]{mcmc_scatter()}}: change the color/size/shape of points corresponding to divergences. \item \code{\link[=mcmc_pairs]{mcmc_pairs()}}: change the color/size/shape of points diff --git a/man/theme_default.Rd b/man/theme_default.Rd index 90002232..02a0210f 100644 --- a/man/theme_default.Rd +++ b/man/theme_default.Rd @@ -10,8 +10,8 @@ theme_default(base_size = getOption("bayesplot.base_size", 12), \arguments{ \item{base_size, base_family}{Base font size and family (passed to \code{\link[ggplot2:theme_bw]{ggplot2::theme_bw()}}). It is possible to set \code{"bayesplot.base_size"} and -\code{"bayesplot.base_family"} via \code{\link[=options]{options()}} to change the defaults, w -hich are \code{12} and \code{"serif"}, respectively.} +\code{"bayesplot.base_family"} via \code{\link[=options]{options()}} to change the defaults, which are +\code{12} and \code{"serif"}, respectively.} } \value{ A ggplot \link[ggplot2:theme]{theme} object. @@ -19,7 +19,8 @@ A ggplot \link[ggplot2:theme]{theme} object. \description{ The \code{\link[=theme_default]{theme_default()}} function returns the default ggplot \link[ggplot2:theme]{theme} used by the \strong{bayesplot} plotting functions. See -\code{\link[=bayesplot_theme_set]{bayesplot_theme_set()}} for details on setting and updating the plotting theme. +\code{\link[=bayesplot_theme_set]{bayesplot_theme_set()}} for details on setting and updating the plotting +theme. } \examples{ class(theme_default())