|
a |
|
b/man/Generate.Accrual.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/accrual.R |
|
|
3 |
\name{Generate.Accrual} |
|
|
4 |
\alias{Generate.Accrual} |
|
|
5 |
\title{Create An AccrualGenerator using a power law recruitment} |
|
|
6 |
\usage{ |
|
|
7 |
Generate.Accrual(start.date, end.date, k, deterministic = FALSE, |
|
|
8 |
rec.start.date = NULL) |
|
|
9 |
} |
|
|
10 |
\arguments{ |
|
|
11 |
\item{start.date}{The start of the subject accrual period} |
|
|
12 |
|
|
|
13 |
\item{end.date}{The date the last subject is accrued so \code{B} = |
|
|
14 |
\code{end.date} - \code{start.date} unless \code{rec.start.date} is used see |
|
|
15 |
below} |
|
|
16 |
|
|
|
17 |
\item{k}{The non-uniformity accrual parameter} |
|
|
18 |
|
|
|
19 |
\item{deterministic}{Logical, if FALSE then the recruitment times |
|
|
20 |
are non-stochastically chosen so that their cumulative distribution function is \code{G(t)} |
|
|
21 |
otherwise they are generated by sampling random variables with a cdf \code{G(t)}} |
|
|
22 |
|
|
|
23 |
\item{rec.start.date}{If this argument is used the subjects are still recruited between |
|
|
24 |
start.date and end.date but they follow the cdf \code{G(t)=(t^k-L^k)/(B^k-L^k)} where |
|
|
25 |
\code{t} is in \code{[L,B]} and \code{B = end.date - rec.start.date} and \code{L = start.date- rec.start.date}.} |
|
|
26 |
} |
|
|
27 |
\value{ |
|
|
28 |
An AccrualGenerator object which generates the required subject accruals |
|
|
29 |
} |
|
|
30 |
\description{ |
|
|
31 |
Subjects are accrued according to the c.d.f |
|
|
32 |
\code{G(t)=t^k/B^k} where \code{k} is a parameter, |
|
|
33 |
\code{t} is the time and \code{B} is the recruitment period. |
|
|
34 |
|
|
|
35 |
See the predict from data vignette for further details |
|
|
36 |
} |
|
|
37 |
|