From 5ff2e536cfc0c0168738bd6cca7cafd3b74492c5 Mon Sep 17 00:00:00 2001
From: melina-leite <melina.leite@ib.usp.br>
Date: Wed, 20 Nov 2024 18:25:13 +0100
Subject: [PATCH] update on some help functions

---
 DHARMa/R/plots.R                           | 2 +-
 DHARMa/R/tests.R                           | 4 ++--
 DHARMa/man/plotSimulatedResiduals.Rd       | 2 +-
 DHARMa/man/testOverdispersion.Rd           | 4 ++--
 DHARMa/man/testOverdispersionParametric.Rd | 4 ++--
 5 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/DHARMa/R/plots.R b/DHARMa/R/plots.R
index 706103d1..c342db40 100644
--- a/DHARMa/R/plots.R
+++ b/DHARMa/R/plots.R
@@ -70,7 +70,7 @@ hist.DHARMa <- function(x,
 }
 
 
-#' DHARMa standard residual plots
+#' DHARMa standard residual plots (deprecated)
 #'
 #' DEPRECATED, use plot() instead
 #'
diff --git a/DHARMa/R/tests.R b/DHARMa/R/tests.R
index 14138445..6ca4cf24 100644
--- a/DHARMa/R/tests.R
+++ b/DHARMa/R/tests.R
@@ -498,7 +498,7 @@ testDispersion <- function(simulationOutput, alternative = c("two.sided", "great
   return(out)
 }
 
-#' Simulated overdisperstion tests
+#' Simulated overdisperstion tests (deprecated)
 #'
 #' @details Deprecated, switch your code to using the [testDispersion] function
 #'
@@ -510,7 +510,7 @@ testOverdispersion <- function(simulationOutput, ...){
   testDispersion(simulationOutput, ...)
 }
 
-#' Parametric overdisperstion tests
+#' Parametric overdisperstion tests (deprecated)
 #'
 #' @details Deprecated, switch your code to using the [testDispersion] function.
 #'
diff --git a/DHARMa/man/plotSimulatedResiduals.Rd b/DHARMa/man/plotSimulatedResiduals.Rd
index 06b3d65c..2a2a78d3 100644
--- a/DHARMa/man/plotSimulatedResiduals.Rd
+++ b/DHARMa/man/plotSimulatedResiduals.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/plots.R
 \name{plotSimulatedResiduals}
 \alias{plotSimulatedResiduals}
-\title{DHARMa standard residual plots}
+\title{DHARMa standard residual plots (deprecated)}
 \usage{
 plotSimulatedResiduals(simulationOutput, ...)
 }
diff --git a/DHARMa/man/testOverdispersion.Rd b/DHARMa/man/testOverdispersion.Rd
index 49efdd25..e9c07063 100644
--- a/DHARMa/man/testOverdispersion.Rd
+++ b/DHARMa/man/testOverdispersion.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/tests.R
 \name{testOverdispersion}
 \alias{testOverdispersion}
-\title{Simulated overdisperstion tests}
+\title{Simulated overdisperstion tests (deprecated)}
 \usage{
 testOverdispersion(simulationOutput, ...)
 }
@@ -12,7 +12,7 @@ testOverdispersion(simulationOutput, ...)
 \item{...}{additional arguments to \link{testDispersion}}
 }
 \description{
-Simulated overdisperstion tests
+Simulated overdisperstion tests (deprecated)
 }
 \details{
 Deprecated, switch your code to using the \link{testDispersion} function
diff --git a/DHARMa/man/testOverdispersionParametric.Rd b/DHARMa/man/testOverdispersionParametric.Rd
index 66f3b401..c3f22c56 100644
--- a/DHARMa/man/testOverdispersionParametric.Rd
+++ b/DHARMa/man/testOverdispersionParametric.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/tests.R
 \name{testOverdispersionParametric}
 \alias{testOverdispersionParametric}
-\title{Parametric overdisperstion tests}
+\title{Parametric overdisperstion tests (deprecated)}
 \usage{
 testOverdispersionParametric(...)
 }
@@ -10,7 +10,7 @@ testOverdispersionParametric(...)
 \item{...}{arguments will be ignored, the parametric tests is no longer recommend}
 }
 \description{
-Parametric overdisperstion tests
+Parametric overdisperstion tests (deprecated)
 }
 \details{
 Deprecated, switch your code to using the \link{testDispersion} function.