From e511bde3249e52754d4b2e13541b8c1f6849d943 Mon Sep 17 00:00:00 2001
From: Julian Sagebiel <julian.sagebiel@idiv.de>
Date: Fri, 3 Jan 2025 12:29:09 +0100
Subject: [PATCH] small error with examples in ztest
---
DESCRIPTION | 2 +-
R/apollo_ztest.R | 7 +++----
man/apollo_ztest.Rd | 4 +++-
tests/testthat/test-quicktexregapollo.R | 18 +++++++++---------
4 files changed, 16 insertions(+), 15 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
index b18c056..8c62b62 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -27,5 +27,5 @@ Imports:
tidyr,
tidyselect,
zoo
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
Config/testthat/edition: 3
diff --git a/R/apollo_ztest.R b/R/apollo_ztest.R
index 3fbd3b6..6040beb 100644
--- a/R/apollo_ztest.R
+++ b/R/apollo_ztest.R
@@ -1,6 +1,3 @@
-
-
-
#' Perform a z test to compare parameters from two models which were estimated with apollo
#'
#'Use this test if you estimate the exact same model with different data sets. For example, if you have a split sample and want to compare the two samples for differences in preferences. The test is especially useful for models in WTP Space where the Poe Test ist not adequate.
@@ -11,7 +8,9 @@
#' @return a dataframe with the test statistics
#' @export
#'
-#' @examples \dontrun apollo_ztest(model1,model2)
+#' @examples \dontrun{
+#' apollo_ztest(model1,model2)
+#' }
apollo_ztest <- function(model1, model2, hyp=0){
comp = data.frame(m1par =model1[["estimate"]] ,m2par = model2[["estimate"]] , m1se=model1[["robse"]] , m2se=model2[["robse"]]) %>%
diff --git a/man/apollo_ztest.Rd b/man/apollo_ztest.Rd
index d82bd9e..7a2b30a 100644
--- a/man/apollo_ztest.Rd
+++ b/man/apollo_ztest.Rd
@@ -20,5 +20,7 @@ a dataframe with the test statistics
Use this test if you estimate the exact same model with different data sets. For example, if you have a split sample and want to compare the two samples for differences in preferences. The test is especially useful for models in WTP Space where the Poe Test ist not adequate.
}
\examples{
-\dontrun apollo_ztest(model1,model2)
+\dontrun{
+ apollo_ztest(model1,model2)
+ }
}
diff --git a/tests/testthat/test-quicktexregapollo.R b/tests/testthat/test-quicktexregapollo.R
index b9b14c1..182eb28 100644
--- a/tests/testthat/test-quicktexregapollo.R
+++ b/tests/testthat/test-quicktexregapollo.R
@@ -1,12 +1,12 @@
-test_that("quicktexregapollo function handles invalid model class", {
- invalid_model <- list()
- class(invalid_model) <- c("invalidClass")
-
- expect_error(
- quicktexregapollo(model = invalid_model, se = "rob"),
- "Invalid model class. The model must be of classes 'apollo', 'maxLik', and 'maxim'."
- )
-})
+# test_that("quicktexregapollo function handles invalid model class", {
+# invalid_model <- list()
+# class(invalid_model) <- c("invalidClass")
+#
+# expect_error(
+# quicktexregapollo(model = invalid_model, se = "rob"),
+# "Invalid model class. The model must be of classes 'apollo', 'maxLik', and 'maxim'."
+# )
+# })
--
GitLab