|
a |
|
b/man/LongLagSettings.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/longlagSettings.R |
|
|
3 |
\name{LongLagSettings} |
|
|
4 |
\alias{LongLagSettings} |
|
|
5 |
\title{Constructor for \code{LongLagSettings} object} |
|
|
6 |
\usage{ |
|
|
7 |
LongLagSettings(analysis.date = as.Date(NA), ndays, toWithdraw, |
|
|
8 |
visitschedule = 0) |
|
|
9 |
} |
|
|
10 |
\arguments{ |
|
|
11 |
\item{analysis.date}{The date the event prediction is performed on. If \code{as.Date(NA)} |
|
|
12 |
then the latest censor/event date from the data set will be used as the analysis.date} |
|
|
13 |
|
|
|
14 |
\item{ndays}{All subjects who were censored more than \code{ndays} before |
|
|
15 |
\code{analysis.date} will be changed} |
|
|
16 |
|
|
|
17 |
\item{toWithdraw}{Logical. If TRUE then the selected subjects will be withdrawn |
|
|
18 |
rather than be censored. If FALSE, their censor date is replaced by \code{analysis.date}} |
|
|
19 |
|
|
|
20 |
\item{visitschedule}{number of days between visits for pfs data. If non-zero and |
|
|
21 |
\code{toWithdraw} is TRUE then the selectedsubjects are censored on the date their |
|
|
22 |
latest visit would have been. See vignette for further details} |
|
|
23 |
} |
|
|
24 |
\value{ |
|
|
25 |
A \code{LongLagSettings} object |
|
|
26 |
} |
|
|
27 |
\description{ |
|
|
28 |
Constructor for \code{LongLagSettings} object |
|
|
29 |
} |
|
|
30 |
|