a b/README.md
1
# eventPrediction
2
3
[![Build Status](https://travis-ci.org/scientific-computing-solutions/eventPrediction.svg?branch=master)](https://travis-ci.org/scientific-computing-solutions/eventPrediction)
4
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/eventPrediction)](https://cran.r-project.org/package=eventPrediction)
5
[![Coverage Status](https://coveralls.io/repos/scientific-computing-solutions/eventPrediction/badge.svg?branch=forCRAN&service=github)](https://coveralls.io/github/scientific-computing-solutions/eventPrediction?branch=forCRAN)
6
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/scientific-computing-solutions/eventPrediction?branch=forCRAN&svg=true)](https://ci.appveyor.com/project/scientific-computing-solutions/eventPrediction)
7
[![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/eventPrediction)](https://cran.r-project.org/package=eventPrediction)
8
9
Event Prediction in Clinical Trials with Time-to-Event Outcomes
10
11
This R package implements methods to predict either the required number to achieve 
12
a target or the expected time at which you will reach the required number of events.
13
You can use this package in the design phase of clinical trials or in the reporting
14
phase. Which means you can use simulate a trial based on a set of assumption and 
15
run prediction and calculate uncertainties when your trial will finish. Alternatively 
16
you can upload your trial data, simulate additional patient recruitment based on 
17
observed one and run prediction on when the target number of event will be reached
18
or the expected number of events at a given time.
19
20
## Contributors
21
Dalevi, Daniel (maintainer); Burkoff, Nikolas; Hollis, Sally; Mann, Helen; Metcalfe,
22
 Paul; Ruau, David;
23
24
## Installation
25
26
To install the development version from GitHub:
27
```R
28
install.packages("devtools")
29
# We spent a lot of time developing the vignettes. We recommend the read but 
30
# building them from source takes some time
31
devtools::install_github("scientific-computing-solutions/eventPrediction", 
32
                         build_vignettes = TRUE)
33
```