diff --git a/R/p_significance.R b/R/p_significance.R index eb86b0fe1..aee7de89c 100644 --- a/R/p_significance.R +++ b/R/p_significance.R @@ -10,10 +10,12 @@ #' @param threshold The threshold value that separates significant from #' negligible effect, which can have following possible values: #' - `"default"`, in which case the range is set to `0.1` if input is a vector, -#' and based on [`rope_range()`] if a Bayesian model is provided. +#' and based on [`rope_range()`] if a (Bayesian) model is provided. #' - a single numeric value (e.g., 0.1), which is used as range around zero -#' (i.e. the threshold range is set to -0.1 and 0.1) -#' - a numeric vector of length two (e.g., `c(-0.2, 0.1)`). +#' (i.e. the threshold range is set to -0.1 and 0.1, i.e. reflects a symmetric +#' interval) +#' - a numeric vector of length two (e.g., `c(-0.2, 0.1)`), useful for +#' asymmetric intervals. #' @inheritParams rope #' @inheritParams hdi #' diff --git a/R/rope_range.R b/R/rope_range.R index 5efdf7093..6b21cdffe 100644 --- a/R/rope_range.R +++ b/R/rope_range.R @@ -32,7 +32,8 @@ #' - For all other models, `-0.1, 0.1` is used to determine the ROPE limits, #' but it is strongly advised to specify it manually. #' -#' @param x A `stanreg`, `brmsfit` or `BFBayesFactor` object. +#' @param x A `stanreg`, `brmsfit` or `BFBayesFactor` object, or a frequentist +#' regression model. #' @param verbose Toggle warnings. #' @inheritParams rope #' diff --git a/man/p_significance.Rd b/man/p_significance.Rd index ebf10cfc3..4d4c944a5 100644 --- a/man/p_significance.Rd +++ b/man/p_significance.Rd @@ -51,10 +51,12 @@ p_significance(x, ...) negligible effect, which can have following possible values: \itemize{ \item \code{"default"}, in which case the range is set to \code{0.1} if input is a vector, -and based on \code{\link[=rope_range]{rope_range()}} if a Bayesian model is provided. +and based on \code{\link[=rope_range]{rope_range()}} if a (Bayesian) model is provided. \item a single numeric value (e.g., 0.1), which is used as range around zero -(i.e. the threshold range is set to -0.1 and 0.1) -\item a numeric vector of length two (e.g., \code{c(-0.2, 0.1)}). +(i.e. the threshold range is set to -0.1 and 0.1, i.e. reflects a symmetric +interval) +\item a numeric vector of length two (e.g., \code{c(-0.2, 0.1)}), useful for +asymmetric intervals. }} \item{use_iterations}{Logical, if \code{TRUE} and \code{x} is a \code{get_predicted} object, diff --git a/man/rope_range.Rd b/man/rope_range.Rd index 65968c458..d92efec78 100644 --- a/man/rope_range.Rd +++ b/man/rope_range.Rd @@ -10,7 +10,8 @@ rope_range(x, ...) \method{rope_range}{default}(x, verbose = TRUE, ...) } \arguments{ -\item{x}{A \code{stanreg}, \code{brmsfit} or \code{BFBayesFactor} object.} +\item{x}{A \code{stanreg}, \code{brmsfit} or \code{BFBayesFactor} object, or a frequentist +regression model.} \item{...}{Currently not used.}