dontrun -> donttest

cf. easystats/easystats#380
easystats · Sep 19, 2023 · 9ae24b1 · 9ae24b1
1 parent 42d2322
commit 9ae24b1
Show file tree

Hide file tree

Showing 65 changed files with 68 additions and 68 deletions.
diff --git a/R/bayesfactor.R b/R/bayesfactor.R
@@ -30,7 +30,7 @@
 #'
 #'   bayesfactor(posterior, prior = prior, verbose = FALSE)
 #' }
-#' \dontrun{
+#' \donttest{
 #' # rstanarm models
 #' # ---------------
 #' if (require("rstanarm")) {

diff --git a/R/bayesfactor_inclusion.R b/R/bayesfactor_inclusion.R
@@ -52,7 +52,7 @@
 #'
 #' as.numeric(bf_inc)
 #'
-#' \dontrun{
+#' \donttest{
 #' # BayesFactor
 #' # -------------------------------
 #' library(BayesFactor)

diff --git a/R/bayesfactor_models.R b/R/bayesfactor_models.R
@@ -76,7 +76,7 @@
 #' # Set check_response = TRUE for transformed responses
 #' bayesfactor_models(lm2b, denominator = lm2, check_response = TRUE)
 #'
-#' \dontrun{
+#' \donttest{
 #' # With lmerMod objects:
 #' # ---------------------
 #' if (require("lme4")) {

diff --git a/R/bayesfactor_parameters.R b/R/bayesfactor_parameters.R
@@ -122,7 +122,7 @@
 #'
 #'   as.numeric(BF_pars)
 #' }
-#' \dontrun{
+#' \donttest{
 #' # rstanarm models
 #' # ---------------
 #' if (require("rstanarm") && require("emmeans") && require("logspline")) {

diff --git a/R/bayesfactor_restricted.R b/R/bayesfactor_restricted.R
@@ -70,7 +70,7 @@
 #' )
 #'
 #' @examplesIf require("rstanarm")
-#' \dontrun{
+#' \donttest{
 #' # rstanarm models
 #' # ---------------
 #' data("mtcars")
@@ -88,7 +88,7 @@
 #' }
 #'
 #' @examplesIf require("rstanarm") && require("emmeans")
-#' \dontrun{
+#' \donttest{
 #' # emmGrid objects
 #' # ---------------
 #' # replicating http://bayesfactor.blogspot.com/2015/01/multiple-comparisons-with-bayesfactor-2.html

diff --git a/R/check_prior.R b/R/check_prior.R
@@ -21,7 +21,7 @@
 #'   determined).
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' library(bayestestR)
 #' if (require("rstanarm")) {
 #'   model <- stan_glm(mpg ~ wt + am, data = mtcars, chains = 1, refresh = 0)

diff --git a/R/convert_bayesian_to_frequentist.R b/R/convert_bayesian_to_frequentist.R
@@ -20,7 +20,7 @@
 #' }
 #' }
 #'
-#' \dontrun{
+#' \donttest{
 #' if (require("rstanarm")) {
 #'   model <- stan_glm(vs ~ mpg,
 #'     family = "binomial",

diff --git a/R/describe_posterior.R b/R/describe_posterior.R
@@ -79,7 +79,7 @@
 #'     describe_posterior(df, keep_iterations = TRUE, verbose = FALSE)
 #'   ))
 #' }
-#' \dontrun{
+#' \donttest{
 #' # rstanarm models
 #' # -----------------------------------------------
 #' if (require("rstanarm") && require("emmeans")) {

diff --git a/R/describe_prior.R b/R/describe_prior.R
@@ -7,7 +7,7 @@
 #' @inheritParams describe_posterior
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' library(bayestestR)
 #'
 #' # rstanarm models

diff --git a/R/diagnostic_draws.R b/R/diagnostic_draws.R
@@ -4,7 +4,7 @@
 #' @inheritParams diagnostic_posterior
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' set.seed(333)
 #'
 #' if (require("brms", quietly = TRUE)) {

diff --git a/R/diagnostic_posterior.R b/R/diagnostic_posterior.R
@@ -28,7 +28,7 @@
 #'
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' # rstanarm models
 #' # -----------------------------------------------
 #' if (require("rstanarm", quietly = TRUE)) {

diff --git a/R/effective_sample.R b/R/effective_sample.R
@@ -16,7 +16,7 @@
 #' }
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' library(rstanarm)
 #' model <- suppressWarnings(
 #'   stan_glm(mpg ~ wt + gear, data = mtcars, chains = 2, iter = 200, refresh = 0)

diff --git a/R/equivalence_test.R b/R/equivalence_test.R
@@ -79,7 +79,7 @@
 #' # print more digits
 #' test <- equivalence_test(x = rnorm(1000, 1, 1), ci = c(.50, .99))
 #' print(test, digits = 4)
-#' \dontrun{
+#' \donttest{
 #' library(rstanarm)
 #' model <- rstanarm::stan_glm(mpg ~ wt + cyl, data = mtcars)
 #' equivalence_test(model)

diff --git a/R/estimate_density.R b/R/estimate_density.R
@@ -72,7 +72,7 @@
 #' # Grouped data
 #' head(estimate_density(iris, at = "Species"))
 #' head(estimate_density(iris$Petal.Width, at = iris$Species))
-#' \dontrun{
+#' \donttest{
 #' # rstanarm models
 #' # -----------------------------------------------
 #' library(rstanarm)

diff --git a/R/eti.R b/R/eti.R
@@ -22,7 +22,7 @@
 #' df <- data.frame(replicate(4, rnorm(100)))
 #' eti(df)
 #' eti(df, ci = c(0.80, 0.89, 0.95))
-#' \dontrun{
+#' \donttest{
 #' library(rstanarm)
 #' model <- suppressWarnings(
 #'   stan_glm(mpg ~ wt + gear, data = mtcars, chains = 2, iter = 200, refresh = 0)

diff --git a/R/hdi.R b/R/hdi.R
@@ -89,7 +89,7 @@
 #'
 #' bayestestR::hdi(iris[1:4])
 #' bayestestR::hdi(iris[1:4], ci = c(0.80, 0.90, 0.95))
-#' \dontrun{
+#' \donttest{
 #' library(rstanarm)
 #' model <- suppressWarnings(
 #'   stan_glm(mpg ~ wt + gear, data = mtcars, chains = 2, iter = 200, refresh = 0)

diff --git a/R/map_estimate.R b/R/map_estimate.R
@@ -19,7 +19,7 @@
 #' - `MAP_Estimate`: The MAP estimate for the posterior or each model parameter.
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' library(bayestestR)
 #'
 #' posterior <- rnorm(10000)

diff --git a/R/mcse.R b/R/mcse.R
@@ -14,7 +14,7 @@
 #' @references Kruschke, J. (2014). Doing Bayesian data analysis: A tutorial with R, JAGS, and Stan. Academic Press.
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' library(bayestestR)
 #' library(rstanarm)
 #'

diff --git a/R/mediation.R b/R/mediation.R
@@ -76,7 +76,7 @@
 #'   the frequentist framework.
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' library(mediation)
 #' library(brms)
 #' library(rstanarm)

diff --git a/R/model_to_priors.R b/R/model_to_priors.R
@@ -7,7 +7,7 @@
 #' @param ... Other arguments for \code{insight::get_prior()} or \code{\link{describe_posterior}}.
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' # brms models
 #' # -----------------------------------------------
 #' if (require("brms")) {

diff --git a/R/p_direction.R b/R/p_direction.R
@@ -113,7 +113,7 @@
 #' df <- data.frame(replicate(4, rnorm(100)))
 #' p_direction(df)
 #' p_direction(df, method = "kernel")
-#' \dontrun{
+#' \donttest{
 #' # rstanarm models
 #' # -----------------------------------------------
 #' if (require("rstanarm")) {

diff --git a/R/p_map.R b/R/p_map.R
@@ -22,7 +22,7 @@
 #'
 #' p_map(rnorm(1000, 0, 1))
 #' p_map(rnorm(1000, 10, 1))
-#' \dontrun{
+#' \donttest{
 #' library(rstanarm)
 #' model <- suppressWarnings(
 #'   stan_glm(mpg ~ wt + gear, data = mtcars, chains = 2, iter = 200, refresh = 0)

diff --git a/R/p_significance.R b/R/p_significance.R
@@ -31,7 +31,7 @@
 #' # -----------------------------------------------
 #' df <- data.frame(replicate(4, rnorm(100)))
 #' p_significance(df)
-#' \dontrun{
+#' \donttest{
 #' # rstanarm models
 #' # -----------------------------------------------
 #' if (require("rstanarm")) {

diff --git a/R/point_estimate.R b/R/point_estimate.R
@@ -31,7 +31,7 @@
 #' df <- data.frame(replicate(4, rnorm(100)))
 #' point_estimate(df, centrality = "all", dispersion = TRUE)
 #' point_estimate(df, centrality = c("median", "MAP"))
-#' \dontrun{
+#' \donttest{
 #' # rstanarm models
 #' # -----------------------------------------------
 #' library(rstanarm)

diff --git a/R/rope.R b/R/rope.R
@@ -102,7 +102,7 @@
 #' rope(x = rnorm(1000, 0, 1), range = c(-0.1, 0.1))
 #' rope(x = rnorm(1000, 1, 0.01), range = c(-0.1, 0.1))
 #' rope(x = rnorm(1000, 1, 1), ci = c(0.90, 0.95))
-#' \dontrun{
+#' \donttest{
 #' library(rstanarm)
 #' model <- suppressWarnings(
 #'   stan_glm(mpg ~ wt + gear, data = mtcars, chains = 2, iter = 200, refresh = 0)

diff --git a/R/rope_range.R b/R/rope_range.R
@@ -42,7 +42,7 @@
 #' @inheritParams rope
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' if (require("rstanarm")) {
 #'   model <- suppressWarnings(stan_glm(
 #'     mpg ~ wt + gear,

diff --git a/R/sensitivity_to_prior.R b/R/sensitivity_to_prior.R
@@ -16,7 +16,7 @@
 #' @param ... Arguments passed to or from other methods.
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' library(bayestestR)
 #'
 #' # rstanarm models

diff --git a/R/sexit.R b/R/sexit.R
@@ -102,7 +102,7 @@
 #' }
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' library(bayestestR)
 #'
 #' s <- sexit(rnorm(1000, -1, 1))

diff --git a/R/sexit_thresholds.R b/R/sexit_thresholds.R
@@ -10,7 +10,7 @@
 #'
 #' @examples
 #' sexit_thresholds(rnorm(1000))
-#' \dontrun{
+#' \donttest{
 #' if (require("rstanarm")) {
 #'   model <- suppressWarnings(stan_glm(
 #'     mpg ~ wt + gear,

diff --git a/R/si.R b/R/si.R
@@ -49,7 +49,7 @@
 #' posterior <- distribution_normal(1000, mean = 0.5, sd = 0.3)
 #'
 #' si(posterior, prior, verbose = FALSE)
-#' \dontrun{
+#' \donttest{
 #' # rstanarm models
 #' # ---------------
 #' library(rstanarm)

diff --git a/R/simulate_priors.R b/R/simulate_priors.R
@@ -9,7 +9,7 @@
 #'   distribution (useful for complex priors and designs).
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' library(bayestestR)
 #' if (require("rstanarm")) {
 #'   model <- suppressWarnings(

diff --git a/R/spi.R b/R/spi.R
@@ -33,7 +33,7 @@
 #' df <- data.frame(replicate(4, rnorm(100)))
 #' spi(df)
 #' spi(df, ci = c(0.80, 0.89, 0.95))
-#' \dontrun{
+#' \donttest{
 #' library(rstanarm)
 #' model <- suppressWarnings(
 #'   stan_glm(mpg ~ wt + gear, data = mtcars, chains = 2, iter = 200, refresh = 0)

diff --git a/man/bayesfactor.Rd b/man/bayesfactor.Rd
diff --git a/man/bayesfactor_inclusion.Rd b/man/bayesfactor_inclusion.Rd
diff --git a/man/bayesfactor_models.Rd b/man/bayesfactor_models.Rd
diff --git a/man/bayesfactor_parameters.Rd b/man/bayesfactor_parameters.Rd
diff --git a/man/bayesfactor_restricted.Rd b/man/bayesfactor_restricted.Rd
diff --git a/man/check_prior.Rd b/man/check_prior.Rd
diff --git a/man/convert_bayesian_as_frequentist.Rd b/man/convert_bayesian_as_frequentist.Rd
diff --git a/man/describe_posterior.Rd b/man/describe_posterior.Rd
diff --git a/man/describe_prior.Rd b/man/describe_prior.Rd
diff --git a/man/diagnostic_draws.Rd b/man/diagnostic_draws.Rd