#2609: added example to derive_vars_transposed showcasing duplicates …

…error
pharmaverse · Feb 18, 2025 · 84a23bb · 84a23bb
1 parent 059406e
commit 84a23bb
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 0 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -21,6 +21,8 @@
 
 ## Documentation
 
+- Added an example to the `derive_vars_transposed()` reference page to showcase how duplicates-related errors can arise when records in `dataset_merge` are not uniquely identified. (#2609)
+
 ## Various
 
 <details>

diff --git a/R/derive_vars_transposed.R b/R/derive_vars_transposed.R
@@ -57,6 +57,7 @@
 #' library(tibble)
 #' library(dplyr, warn.conflicts = FALSE)
 #'
+#' # Adding ATC classes to CM using FACM
 #' cm <- tribble(
 #'   ~USUBJID,       ~CMGRPID, ~CMREFID,  ~CMDECOD,
 #'   "BP40257-1001", "14",     "1192056", "PARACETAMOL",
@@ -96,6 +97,22 @@
 #'     value_var = FASTRESC
 #'   ) %>%
 #'   select(USUBJID, CMDECOD, starts_with("CMATC"))
+#'
+#' # Note: the id_vars argument here is key to uniquely identify
+#' # rows of dataset_merge and avoid duplicates-related errors.
+#' # Compare the above call with:
+#'
+#' cm %>%
+#'   derive_vars_transposed(
+#'     facm,
+#'     by_vars = exprs(USUBJID, CMREFID = FAREFID),
+#'     id_vars = NULL,
+#'     key_var = FATESTCD,
+#'     value_var = FASTRESC
+#'   )
+#'
+#'  get_duplicates_dataset()
+#'
 derive_vars_transposed <- function(dataset,
                                    dataset_merge,
                                    by_vars,

diff --git a/man/derive_vars_transposed.Rd b/man/derive_vars_transposed.Rd