Switch to unified view

a b/man/LongLagSettings-class.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/longlagSettings.R
3
\docType{class}
4
\name{LongLagSettings-class}
5
\alias{LongLagSettings-class}
6
\title{Class which determines how the simulation (from data) 
7
procedure deals with subjects
8
who are censored a long time before the analysis date.}
9
\description{
10
Class which determines how the simulation (from data) 
11
procedure deals with subjects
12
who are censored a long time before the analysis date.
13
}
14
\section{Slots}{
15
16
\describe{
17
\item{\code{analysis.date}}{The date the event prediction is performed on. If \code{as.Date(NA)}
18
then the latest censor/event date from the data set will be used as the analysis.date}
19
20
\item{\code{ndays}}{All subjects who were censored more than \code{ndays} before
21
\code{analysis.date} will be changed}
22
23
\item{\code{toWithdraw}}{Logical. If TRUE then the selected subjects will be withdrawn
24
rather than be censored. If FALSE, their censor date is replaced by \code{analysis.date}}
25
26
\item{\code{visitschedule}}{number of days between visits for pfs data. If non-zero and 
27
\code{toWithdraw} is TRUE then the selectedsubjects are censored on the date their
28
latest visit would have been. See vignette for further details}
29
30
\item{\code{text}}{The text to be disaplyed when printing the LongLagSettings}
31
}}
32
\seealso{
33
\code{\link{show,LongLagSettings-method}}
34
}
35