Add examples to function

pharmaverse · Sep 11, 2024 · 64312d9 · 64312d9
1 parent 42dd3c5
commit 64312d9
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 0 deletions.
diff --git a/R/derive_blfl.R b/R/derive_blfl.R
@@ -260,6 +260,7 @@ dtc_timepart <- function(dtc, partial_as_na = TRUE, ignore_seconds = TRUE) {
 #'
 #' sdtm_in
 #'
+#' # Example 1:
 #' observed_output <- derive_blfl(
 #'   sdtm_in = sdtm_in,
 #'   dm_domain = dm,
@@ -269,6 +270,27 @@ dtc_timepart <- function(dtc, partial_as_na = TRUE, ignore_seconds = TRUE) {
 #' )
 #' observed_output
 #'
+#' # Example 2:
+#' observed_output2 <- derive_blfl(
+#'   sdtm_in = sdtm_in,
+#'   dm_domain = dm,
+#'   tgt_var = "VSLOBXFL",
+#'   ref_var = "RFXSTDTC",
+#'   baseline_timepoints = c("PRE-DOSE")
+#' )
+#' observed_output2
+#'
+#' # Example 3: Output is the same as Example 2
+#' observed_output3 <- derive_blfl(
+#'   sdtm_in = sdtm_in,
+#'   dm_domain = dm,
+#'   tgt_var = "VSLOBXFL",
+#'   ref_var = "RFXSTDTC",
+#'   baseline_visits = c("SCREENING"),
+#'   baseline_timepoints = c("PRE-DOSE")
+#' )
+#' observed_output3
+#'
 derive_blfl <- function(sdtm_in,
                         dm_domain,
                         tgt_var,

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