|
a |
|
b/man/SimQOutput-class.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/simQOutput.R |
|
|
3 |
\docType{class} |
|
|
4 |
\name{SimQOutput-class} |
|
|
5 |
\alias{SimQOutput-class} |
|
|
6 |
\title{A class containing the expected (and CI) dates for a specific item of interest} |
|
|
7 |
\description{ |
|
|
8 |
For example subject recruitment, events occurring, or subject dropout. |
|
|
9 |
Each item of interest will have its own SimQOutput object. This class will |
|
|
10 |
be created for the user and does not need to be manually created |
|
|
11 |
} |
|
|
12 |
\details{ |
|
|
13 |
As an example median[1] is the expected date of the first specific item of interest |
|
|
14 |
whereas upper[1] is the upper CI of the first specific item of interest. |
|
|
15 |
} |
|
|
16 |
\section{Slots}{ |
|
|
17 |
|
|
|
18 |
\describe{ |
|
|
19 |
\item{\code{median}}{A vector of the expected (i.e median) dates |
|
|
20 |
of the first, second, ..., item of interest |
|
|
21 |
The length of the vector is the total number of this type of item.} |
|
|
22 |
|
|
|
23 |
\item{\code{upper}}{A vector of the expected dates for the upper CI |
|
|
24 |
of the first, second, ..., item of interest} |
|
|
25 |
|
|
|
26 |
\item{\code{lower}}{A vector of the expected dates for the lower CI |
|
|
27 |
of the first, second, ..., item of interest} |
|
|
28 |
}} |
|
|
29 |
\seealso{ |
|
|
30 |
\code{\link{simulate,EventModel,missing,missing-method}} \code{\link{FromDataResults-class}} |
|
|
31 |
} |
|
|
32 |
|