|
a |
|
b/man/predict-methods.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/eventPrediction_package.R, R/dataResults.R, R/study.R |
|
|
3 |
\docType{methods} |
|
|
4 |
\name{predict} |
|
|
5 |
\alias{predict} |
|
|
6 |
\alias{predict,FromDataResults-method} |
|
|
7 |
\alias{predict,Study-method} |
|
|
8 |
\title{The predict methods for EventPrediction package} |
|
|
9 |
\usage{ |
|
|
10 |
\S4method{predict}{FromDataResults}(object, time.pred = NULL, |
|
|
11 |
event.pred = NULL) |
|
|
12 |
|
|
|
13 |
\S4method{predict}{Study}(object, time.pred = NULL, event.pred = NULL, |
|
|
14 |
step.size = 0.5) |
|
|
15 |
} |
|
|
16 |
\arguments{ |
|
|
17 |
\item{object}{The object for which the prediction is required} |
|
|
18 |
|
|
|
19 |
\item{time.pred}{If \code{object} is a \code{FromDataResults} object then: |
|
|
20 |
The Dates for which the number of events |
|
|
21 |
are required at. This should be a vector of character strings, |
|
|
22 |
e.g. c("2017-10-10","2018-04-27) or NULL. |
|
|
23 |
If it is a \code{Study} object then this is a numeric vector of |
|
|
24 |
dates (in months from the start of the trial) for which the number |
|
|
25 |
of events are required at.} |
|
|
26 |
|
|
|
27 |
\item{event.pred}{The target number of events for which the expect time |
|
|
28 |
is to be predicted, should be a numeric vector} |
|
|
29 |
|
|
|
30 |
\item{step.size}{The resolution of the grid to be used to calculate the time v |
|
|
31 |
expected events curves} |
|
|
32 |
|
|
|
33 |
\item{...}{Additional objects} |
|
|
34 |
} |
|
|
35 |
\value{ |
|
|
36 |
The predicted values. If \code{object} is \code{Study} the result will |
|
|
37 |
be an \code{AnalysisResults} object. |
|
|
38 |
If \code{object} is a \code{FromDataResults} object it will be |
|
|
39 |
returned with \code{event.pred.data} and/or \code{time.pred.data} slots updated |
|
|
40 |
} |
|
|
41 |
\description{ |
|
|
42 |
The predict methods for EventPrediction package |
|
|
43 |
} |
|
|
44 |
\seealso{ |
|
|
45 |
\code{\link{FromDataResults-class}} \code{\link{AnalysisResults-class}} |
|
|
46 |
} |
|
|
47 |
|