renaming hedgesg to hedges_g

NAMESPACE

@@ -7,12 +7,12 @@ export(any_of)
 export(ard_chisqtest)
 export(ard_cohens_d)
 export(ard_fishertest)
-export(ard_hedgesg)
+export(ard_hedges_g)
 export(ard_kruskaltest)
 export(ard_mcnemartest)
 export(ard_moodtest)
 export(ard_paired_cohens_d)
-export(ard_paired_hedgesg)
+export(ard_paired_hedges_g)
 export(ard_paired_ttest)
 export(ard_paired_wilcoxtest)
 export(ard_proportion_ci)

R/ard_hedgesg.R → R/ard_hedges_g.R

@@ -15,13 +15,13 @@
 #' @param ... arguments passed to `effectsize::hedges_g(...)`
 #'
 #' @return ARD data frame
-#' @name ard_hedgesg
+#' @name ard_hedges_g
 #'
 #' @details
-#' For the `ard_hedgesg()` function, the data is expected to be one row per subject.
+#' For the `ard_hedges_g()` function, the data is expected to be one row per subject.
 #' The data is passed as `effectsize::hedges_g(data[[variable]]~data[[by]], data, paired = FALSE, ...)`.
 #'
-#' For the `ard_paired_hedgesg()` function, the data is expected to be one row
+#' For the `ard_paired_hedges_g()` function, the data is expected to be one row
 #' per subject per by level. Before the effect size is calculated, the data are
 #' reshaped to a wide format to be one row per subject.
 #' The data are then passed as
@@ -30,7 +30,7 @@
 #' @examples
 #' cards::ADSL |>
 #'   dplyr::filter(ARM %in% c("Placebo", "Xanomeline High Dose")) |>
-#'   ard_hedgesg(by = ARM, variable = AGE)
+#'   ard_hedges_g(by = ARM, variable = AGE)
 #'
 #' # constructing a paired data set,
 #' # where patients receive both treatments
@@ -40,12 +40,12 @@
 #'   dplyr::arrange(USUBJID, ARM) |>
 #'   dplyr::group_by(USUBJID) |>
 #'   dplyr::filter(dplyr::n() > 1) |>
-#'   ard_paired_hedgesg(by = ARM, variable = AGE, id = USUBJID)
+#'   ard_paired_hedges_g(by = ARM, variable = AGE, id = USUBJID)
 NULL
 
-#' @rdname ard_hedgesg
+#' @rdname ard_hedges_g
 #' @export
-ard_hedgesg <- function(data, by, variable, ...) {
+ard_hedges_g <- function(data, by, variable, ...) {
   # check installed packages ---------------------------------------------------
   cards::check_pkg_installed("effectsize", reference_pkg = "cardx")
   cards::check_pkg_installed("parameters", reference_pkg = "cardx")
@@ -59,7 +59,7 @@ ard_hedgesg <- function(data, by, variable, ...) {
   check_scalar(variable)
 
   # build ARD ------------------------------------------------------------------
-  .format_hedgesg_results(
+  .format_hedges_g_results(
     by = by,
     variable = variable,
     lst_tidy =
@@ -72,9 +72,9 @@ ard_hedgesg <- function(data, by, variable, ...) {
   )
 }
 
-#' @rdname ard_hedgesg
+#' @rdname ard_hedges_g
 #' @export
-ard_paired_hedgesg <- function(data, by, variable, id, ...) {
+ard_paired_hedges_g <- function(data, by, variable, id, ...) {
   # check installed packages ---------------------------------------------------
   cards::check_pkg_installed("effectsize", reference_pkg = "cardx")
   cards::check_pkg_installed("parameters", reference_pkg = "cardx")
@@ -92,7 +92,7 @@ ard_paired_hedgesg <- function(data, by, variable, id, ...) {
   check_scalar(id)
 
   # build ARD ------------------------------------------------------------------
-  .format_hedgesg_results(
+  .format_hedges_g_results(
     by = by,
     variable = variable,
     lst_tidy =
@@ -119,7 +119,7 @@ ard_paired_hedgesg <- function(data, by, variable, id, ...) {
 #' @return ARD data frame
 #' @keywords internal
 #' @examples
-#' cardx:::.format_hedgesg_results(
+#' cardx:::.format_hedges_g_results(
 #'   by = "ARM",
 #'   variable = "AGE",
 #'   paired = FALSE,
@@ -129,7 +129,7 @@ ard_paired_hedgesg <- function(data, by, variable, id, ...) {
 #'         parameters::standardize_names(style = "broom")
 #'     )
 #' )
-.format_hedgesg_results <- function(by, variable, lst_tidy, paired, ...) {
+.format_hedges_g_results <- function(by, variable, lst_tidy, paired, ...) {
   # build ARD ------------------------------------------------------------------
   ret <-
     cards::tidy_as_ard(
@@ -140,7 +140,7 @@ ard_paired_hedgesg <- function(data, by, variable, id, ...) {
       fun_args_to_record = c("mu", "paired", "pooled_sd", "alternative"),
       formals = formals(asNamespace("effectsize")[["hedges_g"]]),
       passed_args = c(list(paired = paired), dots_list(...)),
-      lst_ard_columns = list(group1 = by, variable = variable, context = "hedgesg")
+      lst_ard_columns = list(group1 = by, variable = variable, context = "hedges_g")
     )
 
   # add the stat label ---------------------------------------------------------

_pkgdown.yml

@@ -27,7 +27,7 @@ reference:
       - ard_chisqtest
       - ard_cohens_d
       - ard_fishertest
-      - ard_hedgesg
+      - ard_hedges_g
       - ard_kruskaltest
       - ard_moodtest
       - ard_mcnemartest

tests/testthat/_snaps/ard_hedgesg.md → tests/testthat/_snaps/ard_hedges_g.md

@@ -1,7 +1,7 @@
-# ard_hedgesg() works
+# ard_hedges_g() works
 
     Code
-      as.data.frame(dplyr::select(ard_hedgesg(cards::ADSL, by = ARM, variable = AGE),
+      as.data.frame(dplyr::select(ard_hedges_g(cards::ADSL, by = ARM, variable = AGE),
       c("variable", "stat_name", "error")))
     Output
         variable   stat_name                                           error
@@ -14,10 +14,10 @@
       7      AGE   pooled_sd Grouping variable y must have exactly 2 levels.
       8      AGE alternative Grouping variable y must have exactly 2 levels.
 
-# ard_paired_hedgesg() works
+# ard_paired_hedges_g() works
 
     Code
-      as.data.frame(dplyr::select(ard_paired_hedgesg(dplyr::mutate(ADSL_paired, ARM = ifelse(
+      as.data.frame(dplyr::select(ard_paired_hedges_g(dplyr::mutate(ADSL_paired, ARM = ifelse(
         dplyr::row_number() == 1L, "3rd ARM", ARM)), by = ARM, variable = AGE, id = USUBJID),
       c("variable", "stat_name", "error")))
     Output

tests/testthat/test-ard_hedgesg.R → tests/testthat/test-ard_hedges_g.R

@@ -1,17 +1,17 @@
 skip_if_not(cards::is_pkg_installed("effectsize", reference_pkg = "cardx"))
 skip_if_not(cards::is_pkg_installed("parameters", reference_pkg = "cardx"))
 
-test_that("ard_hedgesg() works", {
+test_that("ard_hedges_g() works", {
   expect_error(
-    ard_hedgesg <-
+    ard_hedges_g <-
       cards::ADSL |>
       dplyr::filter(ARM %in% c("Placebo", "Xanomeline High Dose")) |>
-      ard_hedgesg(by = ARM, variable = AGE),
+      ard_hedges_g(by = ARM, variable = AGE),
     NA
   )
 
   expect_equal(
-    ard_hedgesg |>
+    ard_hedges_g |>
       cards::get_ard_statistics(stat_name %in% c("estimate", "conf.low", "conf.high")),
     effectsize::hedges_g(
       AGE ~ ARM,
@@ -25,13 +25,13 @@ test_that("ard_hedgesg() works", {
   # errors are properly handled
   expect_snapshot(
     cards::ADSL |>
-      ard_hedgesg(by = ARM, variable = AGE) |>
+      ard_hedges_g(by = ARM, variable = AGE) |>
       dplyr::select(c("variable", "stat_name", "error")) |>
       as.data.frame()
   )
 })
 
-test_that("ard_paired_hedgesg() works", {
+test_that("ard_paired_hedges_g() works", {
   ADSL_paired <-
     cards::ADSL[c("ARM", "AGE")] |>
     dplyr::filter(ARM %in% c("Placebo", "Xanomeline High Dose")) |>
@@ -40,14 +40,14 @@ test_that("ard_paired_hedgesg() works", {
     dplyr::filter(dplyr::n() > 1)
 
   expect_error(
-    ard_paired_hedgesg <-
+    ard_paired_hedges_g <-
       ADSL_paired |>
-      ard_paired_hedgesg(by = ARM, variable = AGE, id = USUBJID),
+      ard_paired_hedges_g(by = ARM, variable = AGE, id = USUBJID),
     NA
   )
 
   expect_equal(
-    ard_paired_hedgesg |>
+    ard_paired_hedges_g |>
       cards::get_ard_statistics(stat_name %in% c("estimate", "conf.low", "conf.high")),
     with(
       data =
@@ -74,7 +74,7 @@ test_that("ard_paired_hedgesg() works", {
       dplyr::mutate(
         ARM = ifelse(dplyr::row_number() == 1L, "3rd ARM", ARM)
       ) |>
-      ard_paired_hedgesg(by = ARM, variable = AGE, id = USUBJID) |>
+      ard_paired_hedges_g(by = ARM, variable = AGE, id = USUBJID) |>
       dplyr::select(c("variable", "stat_name", "error")) |>
       as.data.frame()
   )