From 1467dd6c7b240e02d4cbd2ecc95688e2d2b23e60 Mon Sep 17 00:00:00 2001 From: jgabry Date: Mon, 7 Aug 2017 15:13:28 -0400 Subject: [PATCH] Fix typos in doc [ci skip] --- R/bayesplot-colors.R | 2 +- R/bayesplot_grid.R | 2 +- R/example-data.R | 2 +- R/mcmc-combo.R | 2 +- R/mcmc-diagnostics-nuts.R | 6 +++--- R/mcmc-scatterplots.R | 4 ++-- R/ppc-overview.R | 2 +- man/MCMC-combos.Rd | 2 +- man/MCMC-nuts.Rd | 6 +++--- man/MCMC-scatterplots.Rd | 4 ++-- man/PPC-overview.Rd | 2 +- man/bayesplot-colors.Rd | 2 +- man/bayesplot_grid.Rd | 2 +- man/example-data.Rd | 2 +- 14 files changed, 20 insertions(+), 20 deletions(-) diff --git a/R/bayesplot-colors.R b/R/bayesplot-colors.R index 2a04faa7..bcbfc59a 100644 --- a/R/bayesplot-colors.R +++ b/R/bayesplot-colors.R @@ -33,7 +33,7 @@ #' the scheme names listed above (e.g. "mix-teal-pink", "mix-blue-red", #' etc.). The order of \code{x} and \code{y} matters, i.e., the color #' schemes "mix-blue-red" and "mix-red-blue" are not identical. There is no -#' gaurantee that every possible mixed scheme will look good with every +#' guarantee that every possible mixed scheme will look good with every #' possible plot. #' } #' diff --git a/R/bayesplot_grid.R b/R/bayesplot_grid.R index 3fe6063c..977526dd 100644 --- a/R/bayesplot_grid.R +++ b/R/bayesplot_grid.R @@ -12,7 +12,7 @@ #' \code{widths}, etc.). #' @param titles,subtitles Optional character vectors of plot titles and #' subtitles. If specified, \code{titles} and \code{subtitles} must must have -#' length equal to the number of plots speficied. +#' length equal to the number of plots specified. #' @param xlim,ylim Optionally, numeric vectors of length 2 specifying lower and #' upper limits for the axes that will be shared across all plots. #' @param legends If any of the plots have legends should they be displayed? diff --git a/R/example-data.R b/R/example-data.R index 64db7e79..4ba53be5 100644 --- a/R/example-data.R +++ b/R/example-data.R @@ -52,7 +52,7 @@ NULL #' @rdname example-data #' @export -#' @param chains An interger between 1 and 4 indicating the desired number of +#' @param chains An integer between 1 and 4 indicating the desired number of #' chains. #' @param params An integer between 1 and 6 indicating the desired number of #' parameters. diff --git a/R/mcmc-combo.R b/R/mcmc-combo.R index 6873abd4..c454034f 100644 --- a/R/mcmc-combo.R +++ b/R/mcmc-combo.R @@ -13,7 +13,7 @@ #' relative column widths. For example, if the plot has two columns, then #' \code{widths = c(2, 1)} will allocate more space for the first column by a #' factor of 2 (as would \code{widths = c(.3, .15)}, etc.). The default, -#' \code{NULL}, allocates the same horiztonal space for each column. +#' \code{NULL}, allocates the same horizontal space for each column. #' @param gg_theme Unlike most of the other \pkg{bayesplot} functions, #' \code{mcmc_combo} returns a gtable object rather than a ggplot object, and #' so theme objects can't be added directly to the returned plot object. The diff --git a/R/mcmc-diagnostics-nuts.R b/R/mcmc-diagnostics-nuts.R index c0932ca8..347b40bc 100644 --- a/R/mcmc-diagnostics-nuts.R +++ b/R/mcmc-diagnostics-nuts.R @@ -94,9 +94,9 @@ #' @seealso #' \itemize{ #' \item The \emph{Visual MCMC Diagnostics} vignette. -#' \item Several other plotting functions in the \pkg{bayesplot} -#' package that aren't NUTS-specific but take optional extra arguments -#' if the model was fit using NUTS: +#' \item Several other plotting functions in the \pkg{bayesplot} package that +#' are not NUTS-specific but take optional extra arguments if the model was fit +#' using NUTS: #' \itemize{ #' \item \code{\link{mcmc_trace}} will plot divergences on the traceplot if the #' optional \code{divergences} argument is specified. diff --git a/R/mcmc-scatterplots.R b/R/mcmc-scatterplots.R index 7c097398..3936eff2 100644 --- a/R/mcmc-scatterplots.R +++ b/R/mcmc-scatterplots.R @@ -46,7 +46,7 @@ #' (roughly) half are displayed above the diagonal and half are below (all #' chains are always merged together for the plots along the diagonal). Other #' possibilities are available by setting the \code{condition} argument. -#' Additionally, extra diagonistic information for models fit using +#' Additionally, extra diagnostic information for models fit using #' \code{\link{NUTS}} can be added to the pairs plot using the \code{lp}, #' \code{np}, and \code{np_style} arguments. #' } @@ -392,7 +392,7 @@ mcmc_pairs <- function(x, #' @rdname MCMC-scatterplots #' @export #' @param div_color,div_shape,div_size,td_color,td_shape,td_size Optional -#' rguments to the \code{pairs_style_np} helper function that are eventually +#' arguments to the \code{pairs_style_np} helper function that are eventually #' passed to \code{\link[ggplot2]{geom_point}}. They control the color, shape, #' and size specifications for points representing divergences (\code{div}) #' and points indicating hitting the maximum treedepth (\code{td}). See the diff --git a/R/ppc-overview.R b/R/ppc-overview.R index 89266bc7..128ce51e 100644 --- a/R/ppc-overview.R +++ b/R/ppc-overview.R @@ -39,7 +39,7 @@ #' \eqn{X} we denote the resulting simulations by \eqn{y^{rep}}{yrep} as they #' can be thought of as \emph{replications} of the outcome \eqn{y} rather than #' predictions for future observations. This corresponds to the notation from -#' Gelman et. al. (2013) and is the notation used throughtout the documentation +#' Gelman et. al. (2013) and is the notation used throughout the documentation #' for this package. #' } #' \subsection{Graphical posterior predictive checking}{ diff --git a/man/MCMC-combos.Rd b/man/MCMC-combos.Rd index e2fde7b7..3621647c 100644 --- a/man/MCMC-combos.Rd +++ b/man/MCMC-combos.Rd @@ -22,7 +22,7 @@ the name of one of the available \link{MCMC} functions (omitting the relative column widths. For example, if the plot has two columns, then \code{widths = c(2, 1)} will allocate more space for the first column by a factor of 2 (as would \code{widths = c(.3, .15)}, etc.). The default, -\code{NULL}, allocates the same horiztonal space for each column.} +\code{NULL}, allocates the same horizontal space for each column.} \item{gg_theme}{Unlike most of the other \pkg{bayesplot} functions, \code{mcmc_combo} returns a gtable object rather than a ggplot object, and diff --git a/man/MCMC-nuts.Rd b/man/MCMC-nuts.Rd index 7f125c54..8ecb4191 100644 --- a/man/MCMC-nuts.Rd +++ b/man/MCMC-nuts.Rd @@ -163,9 +163,9 @@ Guide and Reference Manual.} \url{http://mc-stan.org/documentation/} \seealso{ \itemize{ \item The \emph{Visual MCMC Diagnostics} vignette. -\item Several other plotting functions in the \pkg{bayesplot} -package that aren't NUTS-specific but take optional extra arguments -if the model was fit using NUTS: +\item Several other plotting functions in the \pkg{bayesplot} package that +are not NUTS-specific but take optional extra arguments if the model was fit +using NUTS: \itemize{ \item \code{\link{mcmc_trace}} will plot divergences on the traceplot if the optional \code{divergences} argument is specified. diff --git a/man/MCMC-scatterplots.Rd b/man/MCMC-scatterplots.Rd index a4653ac2..edcfa720 100644 --- a/man/MCMC-scatterplots.Rd +++ b/man/MCMC-scatterplots.Rd @@ -125,7 +125,7 @@ is only needed for detecting which transitions (if any) hit the maximum treedepth.} \item{div_color, div_shape, div_size, td_color, td_shape, td_size}{Optional -rguments to the \code{pairs_style_np} helper function that are eventually +arguments to the \code{pairs_style_np} helper function that are eventually passed to \code{\link[ggplot2]{geom_point}}. They control the color, shape, and size specifications for points representing divergences (\code{div}) and points indicating hitting the maximum treedepth (\code{td}). See the @@ -203,7 +203,7 @@ Scatterplots, hexagonal heatmaps, and pairs plots from MCMC draws. See the (roughly) half are displayed above the diagonal and half are below (all chains are always merged together for the plots along the diagonal). Other possibilities are available by setting the \code{condition} argument. - Additionally, extra diagonistic information for models fit using + Additionally, extra diagnostic information for models fit using \code{\link{NUTS}} can be added to the pairs plot using the \code{lp}, \code{np}, and \code{np_style} arguments. } diff --git a/man/PPC-overview.Rd b/man/PPC-overview.Rd index 7b1cebe4..f8739ed0 100644 --- a/man/PPC-overview.Rd +++ b/man/PPC-overview.Rd @@ -39,7 +39,7 @@ or new observations of those predictors. When we use the same values of \eqn{X} we denote the resulting simulations by \eqn{y^{rep}}{yrep} as they can be thought of as \emph{replications} of the outcome \eqn{y} rather than predictions for future observations. This corresponds to the notation from -Gelman et. al. (2013) and is the notation used throughtout the documentation +Gelman et. al. (2013) and is the notation used throughout the documentation for this package. } \subsection{Graphical posterior predictive checking}{ diff --git a/man/bayesplot-colors.Rd b/man/bayesplot-colors.Rd index 6bd4e065..6f98ce5e 100644 --- a/man/bayesplot-colors.Rd +++ b/man/bayesplot-colors.Rd @@ -42,7 +42,7 @@ color_scheme_view(scheme) the scheme names listed above (e.g. "mix-teal-pink", "mix-blue-red", etc.). The order of \code{x} and \code{y} matters, i.e., the color schemes "mix-blue-red" and "mix-red-blue" are not identical. There is no - gaurantee that every possible mixed scheme will look good with every + guarantee that every possible mixed scheme will look good with every possible plot. } diff --git a/man/bayesplot_grid.Rd b/man/bayesplot_grid.Rd index ba4dac02..488b4e85 100644 --- a/man/bayesplot_grid.Rd +++ b/man/bayesplot_grid.Rd @@ -23,7 +23,7 @@ upper limits for the axes that will be shared across all plots.} \item{titles, subtitles}{Optional character vectors of plot titles and subtitles. If specified, \code{titles} and \code{subtitles} must must have -length equal to the number of plots speficied.} +length equal to the number of plots specified.} \item{legends}{If any of the plots have legends should they be displayed? Defaults to \code{TRUE}.} diff --git a/man/example-data.Rd b/man/example-data.Rd index 0f8b20f6..4da9f314 100644 --- a/man/example-data.Rd +++ b/man/example-data.Rd @@ -20,7 +20,7 @@ example_x_data() example_group_data() } \arguments{ -\item{chains}{An interger between 1 and 4 indicating the desired number of +\item{chains}{An integer between 1 and 4 indicating the desired number of chains.} \item{params}{An integer between 1 and 6 indicating the desired number of