forked from pharmaverse/admiral
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathderive_var_aendy.Rd
53 lines (42 loc) · 1.59 KB
/
derive_var_aendy.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/derive_var_aendy.R
\name{derive_var_aendy}
\alias{derive_var_aendy}
\title{Derive Analysis End Relative Day}
\usage{
derive_var_aendy(dataset, reference_date = TRTSDT, date = AENDT)
}
\arguments{
\item{dataset}{Input dataset
The columns specified by the \code{reference_date} and the \code{date} parameter are
expected.}
\item{reference_date}{The start date column, e.g., date of first treatment
A date or date-time object column is expected.
Refer to \code{derive_vars_dt()} to impute and derive a date from a date character vector to a date object.
The default is \code{TRTSDT}.}
\item{date}{The end date column for which the study day should be derived
A date or date-time object column is expected.
Refer to \code{derive_vars_dt()} to impute and derive a date from a date character vector to a date object.
The default is \code{AENDT}}
}
\value{
The input dataset with \code{AENDY} column added
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}}
This function is \emph{deprecated}, please use \code{derive_vars_dy()} instead.
Adds the analysis end relative day (\code{AENDY}) to the dataset, i.e. study day
of analysis end date
}
\details{
The study day is derived as number of days from the start date
to the end date. If it is nonnegative, one is added. I.e., the study day of the
start date is 1.
}
\author{
Stefan Bundfuss
}
\keyword{bds}
\keyword{derivation}
\keyword{occds}
\keyword{timing}