Add tests

R/ard_stats_poisson_test.R

@@ -15,8 +15,7 @@
 #' @param conf.level (scalar `numeric`)\cr
 #'   confidence level for confidence interval. Default is `0.95`.
 #' @param na.rm (scalar `logical`)\cr
-#'   whether missing values should be removed before summing the numerator and the denominator. Default
-#'   is `TRUE`.
+#'   whether missing values should be removed before summing the numerator and the denominator. Default is `TRUE`.
 #' @param ... arguments passed to [poisson.test()].
 #' @return an ARD data frame of class 'card'
 #' @name ard_stats_poisson_test
@@ -124,7 +123,8 @@ ard_stats_poisson_test <- function(data, numerator, denominator, na.rm = TRUE, b
       formals = formals(asNamespace("stats")[["poisson.test"]]),
       passed_args = dots_list(...),
       lst_ard_columns = list(context = "stats_poisson_test")
-    )
+    ) |>
+    dplyr::distinct()
 
   # rename "r" statistic to "mu"
   ret$stat_name[ret$stat_name == "r"] <- "mu"

tests/testthat/_snaps/ard_stats_poisson_test.md

@@ -0,0 +1,8 @@
+# ard_stats_poisson_test() errors are handled correctly
+
+    Code
+      ard_stats_poisson_test(cards::ADTTE, by = TRTA, numerator = CNSR, denominator = AVAL)
+    Condition
+      Error in `ard_stats_poisson_test()`:
+      ! The `by` argument must have a maximum of two levels.
+

tests/testthat/test-ard_stats_poisson_test.R

@@ -0,0 +1,81 @@
+skip_if_not(is_pkg_installed("broom", reference_pkg = "cardx"))
+
+test_that("ard_stats_poisson_test() works for one sample tests", {
+  # Default values work
+  expect_silent(
+    ard_stats_poisson_test(cards::ADTTE, numerator = CNSR, denominator = AVAL)
+  )
+
+  # Custom values work
+  expect_silent(
+    ard_single <- ard_stats_poisson_test(
+      cards::ADTTE,
+      numerator = "CNSR",
+      denominator = "AVAL",
+      conf.level = 0.90,
+      r = 0.8,
+      alternative = "greater"
+    )
+  )
+
+  # Statistics calculated correctly
+  expect_equal(
+    ard_single |>
+      cards::get_ard_statistics(
+        stat_name %in%
+          c("estimate", "statistic", "p.value", "parameter", "conf.low", "conf.high", "method", "alternative")
+      ),
+    poisson.test(
+      x = sum(cards::ADTTE$CNSR),
+      T = sum(cards::ADTTE$AVAL),
+      r = 0.8,
+      conf.level = 0.9,
+      alternative = "greater"
+    ) |>
+      broom::tidy() |>
+      unclass(),
+    ignore_attr = TRUE
+  )
+})
+
+test_that("ard_stats_poisson_test() works for two sample tests", {
+  expect_silent(
+    ard_compare <-
+      cards::ADTTE |>
+      dplyr::filter(TRTA %in% c("Placebo", "Xanomeline High Dose")) |>
+      ard_stats_poisson_test(by = TRTA, numerator = CNSR, denominator = AVAL)
+  )
+
+  # Statistics calculated correctly
+  expect_equal(
+    ard_compare |>
+      cards::get_ard_statistics(
+        stat_name %in%
+          c("estimate", "statistic", "p.value", "parameter", "conf.low", "conf.high", "method", "alternative")
+      ),
+    poisson.test(
+      x = cards::ADTTE |>
+        dplyr::filter(TRTA %in% c("Placebo", "Xanomeline High Dose")) |>
+        dplyr::group_by(TRTA) |>
+        dplyr::summarise(sum = sum(CNSR)) |>
+        dplyr::pull(sum),
+      T = cards::ADTTE |>
+        dplyr::filter(TRTA %in% c("Placebo", "Xanomeline High Dose")) |>
+        dplyr::group_by(TRTA) |>
+        dplyr::summarise(sum = sum(AVAL)) |>
+        dplyr::pull(sum)
+    ) |>
+      broom::tidy() |>
+      unclass(),
+    ignore_attr = TRUE
+  )
+
+})
+
+test_that("ard_stats_poisson_test() errors are handled correctly", {
+  expect_snapshot(
+    cards::ADTTE |>
+      ard_stats_poisson_test(by = TRTA, numerator = CNSR, denominator = AVAL),
+    error = TRUE
+  )
+})