File: Design.Rd

package info (click to toggle)
r-cran-mediana 1.0.8-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 2,004 kB
  • sloc: sh: 4; makefile: 2
file content (89 lines) | stat: -rw-r--r-- 4,368 bytes parent folder | download
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
\name{Design}
\alias{Design}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{Design object
}
\description{
This function creates an object of class \code{Design} which can be added to an object of class \code{DataModel}.
}
\usage{
Design(enroll.period = NULL,
       enroll.dist = NULL,
       enroll.dist.par = NULL,
       followup.period = NULL,
       study.duration = NULL,
       dropout.dist = NULL,
       dropout.dist.par = NULL)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
  \item{enroll.period}{
  defines the length of the enrollment period.
}
  \item{enroll.dist}{
  defines the enrollment distribution.
}
  \item{enroll.dist.par}{
  defines the parameters of the enrollment distribution (optional).
}
  \item{followup.period}{
defines the length of the follow-up period for each patient in study designs with a fixed follow-up period, i.e., the length of time from the enrollment to planned discontinuation is constant across patients. The user must specify either \code{followup.period} or \code{study.duration}.
}
  \item{study.duration}{
defines the total study duration in study designs with a variable follow-up period. The total study duration is defined as the length of time from the enrollment of the first patient to the discontinuation of the last patient.
}
  \item{dropout.dist}{defines the dropout distribution.
}
  \item{dropout.dist.par}{defines the parameters of the dropout distribution.
}
}
\details{
Objects of class \code{Design} are used in objects of class \code{DataModel} to specify the design parameters used in event-driven designs if the user is interested in modeling the enrollment (or accrual) and dropout (or loss to follow up) processes that will be applied to the Clinical Scenario. Several objects of class \code{Design} can be added to an object of class \code{DataModel}.

Note that the length of the enrollment period, total study duration and follow-up periods are measured using the same time units.

If \code{enroll.dist = "UniformDist"}, the \code{enroll.dist.par} should be let to \code{NULL} (then enrollment distribution will be uniform during the enrollment period).

If \code{enroll.dist = "BetaDist"}, the \code{enroll.dist.par} should contain the parameter of the beta distribution (\code{a} and \code{b}). These parameters must be derived according to the expected enrollment at a specific timepoint. For example, if half the patients are expected to be enrolled at 75\% of the enrollment period, the beta distribution is a \code{Beta(log(0.5)/log(0.75), 1)}. Generally, let \code{q} be the proportion of enrolled patients at \code{p}\% of the enrollment period, the Beta distribution can be derived as follows:
\itemize{
\item If \code{q} >  \code{p}, the Beta distribution is \code{Beta(a,1)} with \code{a = log(p) / log(q)}
\item If \code{q} <  \code{p}, the Beta distribution is \code{Beta (1,b)} with \code{b = log(1-p) / log(1-q)}
\item Otherwise the Beta distribution is \code{Beta(1,1)}
}

If \code{dropout.dist = "UniformDist"}, the \code{dropout.dist.par} should contain the dropout rate. This parameter must be specified using the \code{prop} parameter, such as \code{dropout.dist.par = parameters(prop = 0.1)} for a 10\% dropout rate.
}

\references{
\url{http://gpaux.github.io/Mediana/}
}

\seealso{
See Also \code{\link{DataModel}}.
}
\examples{
## Create DataModel object with a Design Object
data.model = DataModel() +
             Design(enroll.period = 9,
                    study.duration = 21,
                    enroll.dist = "UniformDist",
                    dropout.dist = "ExpoDist",
                    dropout.dist.par = parameters(rate = 0.0115))

## Create DataModel object with several Design Objects
design1 = Design(enroll.period = 9,
                 study.duration = 21,
                 enroll.dist = "UniformDist",
                 dropout.dist = "ExpoDist",
                 dropout.dist.par = parameters(rate = 0.0115))

design2 = Design(enroll.period   = 18,
                 study.duration = 24,
                 enroll.dist = "UniformDist",
                 dropout.dist = "ExpoDist",
                 dropout.dist.par = parameters(rate = 0.0115))

data.model = DataModel() +
             design1 +
             design2
}