From b936cf17d6e47eed3d2079080468dc84d33edb09 Mon Sep 17 00:00:00 2001
From: Rosemary Li
Date: Mon, 22 Jan 2024 05:08:39 +0000
Subject: [PATCH] update document
---
NAMESPACE | 1 +
man/calculate_study_day.Rd | 20 ++++++++++----------
2 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/NAMESPACE b/NAMESPACE
index 455b5386..4651ec2a 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -1,5 +1,6 @@
# Generated by roxygen2: do not edit by hand
+export(calculate_study_day)
export(create_iso8601)
export(fmt_cmp)
importFrom(rlang,.data)
diff --git a/man/calculate_study_day.Rd b/man/calculate_study_day.Rd
index ec71af05..03b2b8cb 100644
--- a/man/calculate_study_day.Rd
+++ b/man/calculate_study_day.Rd
@@ -5,33 +5,33 @@
\title{\code{calculate_study_day} performs study day calculation}
\usage{
calculate_study_day(
- ds_in,
- ds_dm,
- refdt,
+ sdtm_in,
+ dm_domain = DM,
+ refdt = "RFSTDTC",
tgdt,
study_day_var,
merge_key = "USUBJID"
)
}
\arguments{
-\item{ds_in}{input data.frame that contains the target date.}
+\item{sdtm_in}{input data.frame that contains the target date.}
-\item{ds_dm}{reference date.frame that contains the reference date.}
+\item{dm_domain}{reference date.frame that contains the reference date.}
-\item{refdt}{reference date from \code{ds_dm} that will be used as reference to
+\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{ds_in} that will be used to calcualte the study
+\item{tgdt}{target date from \code{sdtm_in} that will be used to calcualte the study
day.}
\item{study_day_var}{the new study day variable name in the output. For
example, AESTDY for AE domain for CMSTDY for CM domain.}
-\item{merge_key}{character to represents the merging key between \code{ds_in} and
-\code{ds_dm}.}
+\item{merge_key}{character to represents the merging key between \code{sdtm_in} and
+\code{dm_domain}.}
}
\value{
-a data.frame that takes all columns from \code{ds_in} and a new variable
+a data.frame that takes all columns from \code{sdtm_in} and a new variable
to represent the calculated study day.
}
\description{