From 0905ba47cb8050a80a548366e5eb971b3a0dadfb Mon Sep 17 00:00:00 2001 From: "Logan C. Brooks" Date: Wed, 4 Oct 2023 16:52:40 -0700 Subject: [PATCH] "Logical" -> "Scalar logical" as appropriate to match rest of docs --- R/layer_cdc_flatline_quantiles.R | 4 ++-- man/layer_cdc_flatline_quantiles.Rd | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/R/layer_cdc_flatline_quantiles.R b/R/layer_cdc_flatline_quantiles.R index 16538f0e1..d9d192563 100644 --- a/R/layer_cdc_flatline_quantiles.R +++ b/R/layer_cdc_flatline_quantiles.R @@ -32,7 +32,7 @@ #' These samples are spaced evenly on the (0, 1) scale, F_X(x) resulting in #' linear interpolation on the X scale. This is achieved with #' [stats::quantile()] Type 7 (the default for that function). -#' @param symmetrize Logical. If `TRUE`, does two things: (i) forces the +#' @param symmetrize Scalar logical. If `TRUE`, does two things: (i) forces the #' "empirical" CDF of residuals to be symmetric by pretending that for every #' actually-observed residual X we also observed another residual -X, and (ii) #' at each ahead, forces the median simulated value to be equal to the point @@ -41,7 +41,7 @@ #' simulating the next ahead. This forces any 1-ahead predictive intervals to #' be symmetric about the point prediction, and encourages larger aheads to be #' more symmetric. -#' @param nonneg Logical. Force all predictive intervals be non-negative. +#' @param nonneg Scalar logical. Force all predictive intervals be non-negative. #' Because non-negativity is forced _before_ propagating forward, this has #' slightly different behaviour than would occur if using [layer_threshold()]. #' Thresholding at each ahead takes place after any shifting from diff --git a/man/layer_cdc_flatline_quantiles.Rd b/man/layer_cdc_flatline_quantiles.Rd index 5e72378b3..55a1a378e 100644 --- a/man/layer_cdc_flatline_quantiles.Rd +++ b/man/layer_cdc_flatline_quantiles.Rd @@ -39,7 +39,7 @@ linear interpolation on the X scale. This is achieved with \item{by_key}{A character vector of keys to group the residuals by before calculating quantiles. The default, \code{c()} performs no grouping.} -\item{symmetrize}{Logical. If \code{TRUE}, does two things: (i) forces the +\item{symmetrize}{Scalar logical. If \code{TRUE}, does two things: (i) forces the "empirical" CDF of residuals to be symmetric by pretending that for every actually-observed residual X we also observed another residual -X, and (ii) at each ahead, forces the median simulated value to be equal to the point @@ -49,7 +49,7 @@ simulating the next ahead. This forces any 1-ahead predictive intervals to be symmetric about the point prediction, and encourages larger aheads to be more symmetric.} -\item{nonneg}{Logical. Force all predictive intervals be non-negative. +\item{nonneg}{Scalar logical. Force all predictive intervals be non-negative. Because non-negativity is forced \emph{before} propagating forward, this has slightly different behaviour than would occur if using \code{\link[=layer_threshold]{layer_threshold()}}. Thresholding at each ahead takes place after any shifting from