doc: add examples for throw_msg_if_duplicates

gdrplatform · Oct 9, 2024 · 50bd9f3 · 50bd9f3
1 parent f08ecb9
commit 50bd9f3
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/R/duplicates.R b/R/duplicates.R
@@ -151,7 +151,11 @@ get_assay_dt_duplicated_rows <- function(dt, output = "index") {
 #' @param assay_name string with the name of the assay
 #' @param msg_f function to be used to throw the message
 #' @param preview_max_numb number of rows to preview if duplicates found
-#' 
+#' @examples
+#' sdata <- get_synthetic_data("finalMAE_small")
+#' smetrics_data <- convert_se_assay_to_dt(sdata[[1]], "Metrics")
+#' throw_msg_if_duplicates(smetrics_data, assay_name = "Metrics")
+#' throw_msg_if_duplicates(smetrics_data, assay_name = "Metrics", msg_f = futile.logger::flog.info)
 #' @return NULL
 #' @keywords duplicates
 #'

diff --git a/man/get_duplicated_rows.Rd b/man/get_duplicated_rows.Rd
diff --git a/man/throw_msg_if_duplicates.Rd b/man/throw_msg_if_duplicates.Rd