Add roxygen template for prob,prob_outer

Author: jgabry

NEWS.md

@@ -22,8 +22,9 @@ Geom more appropriate for discrete data. (#145)
 and [LOO predictive checks](http://mc-stan.org/bayesplot/reference/PPC-loo.html)
 now draw both an outer and an inner probability interval, which can be
 controlled through the new argument `prob_outer` and the already existing
-`prob`, consistently with what is produced by `mcmc_intervals()` and similar.
-(#154, @mcol)
+`prob`. This is consistent with what is produced by `mcmc_intervals()`.
+(#152, #154, @mcol)
+
 
 # bayesplot 1.5.0
 

R/ppc-intervals.R

@@ -7,15 +7,12 @@
 #' @family PPCs
 #'
 #' @template args-y-yrep
+#' @template args-prob-prob_outer
 #' @param x A numeric vector the same length as \code{y} to use as the x-axis
 #'   variable. For example, \code{x} could be a predictor variable from a
 #'   regression model, a time variable for time-series models, etc. If \code{x}
 #'   is missing or NULL, then \code{1:length(y)} is used for the x-axis.
 #' @param ... Currently unused.
-#' @param prob A value between 0 and 1 indicating the desired probability mass
-#'   to include in the inner \code{yrep} intervals. The default is 0.5.
-#' @param prob_outer The probability mass to include in the outer \code{yrep}
-#'   interval. The default is 0.9.
 #' @param alpha,size,fatten Arguments passed to geoms. For ribbon plots
 #'   \code{alpha} and \code{size} are passed to
 #'   \code{\link[ggplot2]{geom_ribbon}}. For interval plots \code{size} and

R/ppc-loo.R

@@ -90,11 +90,11 @@
 #'
 #' # loo predictive intervals vs observations
 #' keep_obs <- 1:50
-#' ppc_loo_intervals(y, yrep, psis_object = psis1, subset = keep_obs, prob = 0.9)
+#' ppc_loo_intervals(y, yrep, psis_object = psis1, subset = keep_obs)
 #'
 #' color_scheme_set("gray")
 #' ppc_loo_intervals(y, yrep, psis_object = psis1, subset = keep_obs,
-#'                   order = "median", prob = 0.9)
+#'                   order = "median")
 #' }
 #'
 NULL
@@ -265,13 +265,10 @@ ppc_loo_pit <-
 
 #' @rdname PPC-loo
 #' @export
+#' @template args-prob-prob_outer
 #' @param psis_object If using \pkg{loo} version \code{2.0.0} or greater, an
 #'   object returned by the \code{psis} function (or by the \code{loo} function
 #'   with argument \code{save_psis} set to \code{TRUE}).
-#' @param prob A value between 0 and 1 indicating the desired probability mass
-#'   to include in the inner interval. The default is 0.5.
-#' @param prob_outer The probability mass to include in the outer interval.
-#'   The default is 0.9.
 #' @param intervals For \code{ppc_loo_intervals} and \code{ppc_loo_ribbon},
 #'   optionally a matrix of precomputed LOO predictive intervals
 #'   that can be specified instead of \code{yrep} and \code{lw} (these are both

man-roxygen/args-prob-prob_outer.R

@@ -0,0 +1,3 @@
+#' @param prob,prob_outer Values between 0 and 1 indicating the desired
+#'   probability mass to include in the inner and outer intervals. The defaults
+#'   are \code{prob=0.5} and \code{prob_outer=0.9}.