From fa26e738c5b32006cc3da5c8a55b729fcb155844 Mon Sep 17 00:00:00 2001
From: Rosemary Li
Date: Mon, 19 Feb 2024 16:23:46 +0000
Subject: [PATCH] man file update
---
R/calculate_study_day.R | 6 +++---
man/calculate_study_day.Rd | 16 ++++++++--------
2 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/R/calculate_study_day.R b/R/calculate_study_day.R
index dd4ee60c..52d5b7f6 100644
--- a/R/calculate_study_day.R
+++ b/R/calculate_study_day.R
@@ -7,13 +7,13 @@
#' NA will be returned for those records.
#'
#' @param sdtm_in Input data frame that contains the target date.
-#' @param dm_domain Reference date frame that contains the reference date.
-#' @param refdt Reference date from `dm_domain` that will be used as reference to
-#' calculate the study day.
#' @param tgdt Target date from `sdtm_in` that will be used to calculate the study
#' day.
#' @param study_day_var New study day variable name in the output. For
#' example, AESTDY for AE domain and CMSTDY for CM domain.
+#' @param dm_domain Reference date frame that contains the reference date.
+#' @param refdt Reference date from `dm_domain` that will be used as reference to
+#' calculate the study day.
#' @param merge_key Character to represents the merging key between `sdtm_in` and
#' `dm_domain`.
#'
diff --git a/man/calculate_study_day.Rd b/man/calculate_study_day.Rd
index 724b6dfe..201cfcab 100644
--- a/man/calculate_study_day.Rd
+++ b/man/calculate_study_day.Rd
@@ -6,27 +6,27 @@
\usage{
calculate_study_day(
sdtm_in,
- dm_domain,
- refdt = "RFSTDTC",
tgdt,
study_day_var,
+ dm_domain = "DM",
+ refdt = "RFSTDTC",
merge_key = "USUBJID"
)
}
\arguments{
\item{sdtm_in}{Input data frame that contains the target date.}
-\item{dm_domain}{Reference date frame that contains the reference date.}
-
-\item{refdt}{Reference date from \code{dm_domain} that will be used as reference to
-calculate the study day.}
-
\item{tgdt}{Target date from \code{sdtm_in} that will be used to calculate the study
day.}
\item{study_day_var}{New study day variable name in the output. For
example, AESTDY for AE domain and CMSTDY for CM domain.}
+\item{dm_domain}{Reference date frame that contains the reference date.}
+
+\item{refdt}{Reference date from \code{dm_domain} that will be used as reference to
+calculate the study day.}
+
\item{merge_key}{Character to represents the merging key between \code{sdtm_in} and
\code{dm_domain}.}
}
@@ -52,6 +52,6 @@ dm <- data.frame(
)
ae$AESTDTC <- as.Date(ae$AESTDTC)
dm$RFSTDTC <- as.Date(dm$RFSTDTC)
-calculate_study_day(ae, dm, "RFSTDTC", "AESTDTC", "AESTDY")
+calculate_study_day(ae, "AESTDTC", "AESTDY", "dm", "RFSTDTC")
}