View source: R/f_design_plan_survival.R
getNumberOfSubjects | R Documentation |
Returns the number of recruited subjects at given time vector.
getNumberOfSubjects(
time,
...,
accrualTime = c(0, 12),
accrualIntensity = 0.1,
accrualIntensityType = c("auto", "absolute", "relative"),
maxNumberOfSubjects = NA_real_
)
time |
A numeric vector with time values. |
... |
Ensures that all arguments (starting from the "...") are to be named and that a warning will be displayed if unknown arguments are passed. |
accrualTime |
The assumed accrual time intervals for the study, default is
|
accrualIntensity |
A numeric vector of accrual intensities, default is the relative
intensity |
accrualIntensityType |
A character value specifying the accrual intensity input type.
Must be one of |
maxNumberOfSubjects |
If |
Calculate number of subjects over time range at given accrual time vector
and accrual intensity. Intensity can either be defined in absolute or
relative terms (for the latter, maxNumberOfSubjects
needs to be defined)
The function is used by getSampleSizeSurvival()
.
Returns a NumberOfSubjects
object.
The following generics (R generic functions) are available for this result object:
names()
to obtain the field names,
print()
to print the object,
summary()
to display a summary of the object,
plot()
to plot the object,
as.data.frame()
to coerce the object to a data.frame
,
as.matrix()
to coerce the object to a matrix
.
Click on the link of a generic in the list above to go directly to the help documentation of
the rpact
specific implementation of the generic.
Note that you can use the R function methods
to get all the methods of a generic and
to identify the object specific name of it, e.g.,
use methods("plot")
to get all the methods for the plot
generic.
There you can find, e.g., plot.AnalysisResults
and
obtain the specific help documentation linked above by typing ?plot.AnalysisResults
.
AccrualTime
for defining the accrual time.
getNumberOfSubjects(time = seq(10, 70, 10), accrualTime = c(0, 20, 60),
accrualIntensity = c(5, 20))
getNumberOfSubjects(time = seq(10, 70, 10), accrualTime = c(0, 20, 60),
accrualIntensity = c(0.1, 0.4), maxNumberOfSubjects = 900)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.