updates for deprecated function

atorus-research · Sep 11, 2024 · 7967a51 · 7967a51
1 parent 791d032
commit 7967a51
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 7 deletions.
diff --git a/R/split.R → R/deprec-split.R b/R/split.R → R/deprec-split.R
@@ -1,4 +1,7 @@
-#' Split xpt file output
+#' Deprecated - Split xpt file output
+#'
+#' @description
+#' `r lifecycle::badge("deprecated")`
 #'
 #' Per the FDA Study Data Technical Conformance
 #' Guide(https://www.fda.gov/media/88173/download) section 3.3.2, dataset files
@@ -18,8 +21,8 @@
 #' knows how to split the data frame.
 #'
 #'
-#' @export
 #'
+#' @export
 #' @examples
 #'
 #' adlb <- data.frame(
@@ -29,7 +32,9 @@
 #'
 #' adlb <- xportr_split(adlb, "LBCAT")
 xportr_split <- function(.df, split_by = NULL) {
+ .Deprecated("xportr_write(max_size_gb = ..")
  attr(.df, "_xportr.split_by_") <- split_by
-
  return(.df)
 }
+
+#' @rdname xportr_split-deprecated
diff --git a/man/xportr_split.Rd b/man/xportr_split.Rd
diff --git a/tests/testthat/test-deprecation.R b/tests/testthat/test-deprecation.R
@@ -98,3 +98,16 @@ test_that(
  expect_error(xportr_type(df, metacore = df_meta))
  }
 )
+
+## Test 7: xportr_split: using deprecated function gives a warning----
+test_that(
+ "deprecation xportr_split: using deprecated function gives a warning",
+ {
+ adlb <- data.frame(
+ USUBJID = c(1001, 1002, 1003),
+ LBCAT = c("HEMATOLOGY", "HEMATOLOGY", "CHEMISTRY")
+ )
+
+ expect_warning(adlb <- xportr_split(adlb, "LBCAT"))
+ }
+)