diff --git a/R/p_significance.R b/R/p_significance.R index f2f7251db..1e0841881 100644 --- a/R/p_significance.R +++ b/R/p_significance.R @@ -7,7 +7,7 @@ bayestestR::p_significance #' @title Practical Significance (ps) #' #' @description Compute the probability of **Practical Significance** -#' (***ps***), which can be conceptualized as a unidirectional equivalence test. +#' (*ps*), which can be conceptualized as a unidirectional equivalence test. #' It returns the probability that an effect is above a given threshold #' corresponding to a negligible effect in the median's direction, considering #' a parameter's confidence interval. In comparison the the [`equivalence_test()`] @@ -100,7 +100,7 @@ print.p_significance_lm <- function(x, digits = 2, p_digits = 3, ...) { } caption <- sprintf( "Practical Significance (threshold: %s)", - paste(insight::format_value(threshold, digits = 2), collapse = ", ") + toString(insight::format_value(threshold, digits = 2)) ) x$ps <- insight::format_p(x$ps, name = "ps", digits = p_digits) x <- insight::format_table(x, digits = digits, p_digits = p_digits) diff --git a/inst/WORDLIST b/inst/WORDLIST index af9217f46..161941391 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -300,6 +300,7 @@ posthoc pre priori probabilistically +ps pscl quantreg quartiles diff --git a/man/p_significance.lm.Rd b/man/p_significance.lm.Rd index c54fc6fae..e1b3a1309 100644 --- a/man/p_significance.lm.Rd +++ b/man/p_significance.lm.Rd @@ -30,7 +30,7 @@ A data frame. } \description{ Compute the probability of \strong{Practical Significance} -(\emph{\strong{ps}}), which can be conceptualized as a unidirectional equivalence test. +(\emph{ps}), which can be conceptualized as a unidirectional equivalence test. It returns the probability that an effect is above a given threshold corresponding to a negligible effect in the median's direction, considering a parameter's confidence interval. In comparison the the \code{\link[=equivalence_test]{equivalence_test()}} diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml index b5d559035..49ee9730f 100644 --- a/pkgdown/_pkgdown.yml +++ b/pkgdown/_pkgdown.yml @@ -62,7 +62,7 @@ reference: - equivalence_test.lm - p_calibrate - p_function - - p_significance + - p_significance.lm - title: "Parameter Sampling" contents: