diff --git a/README.md b/README.md index e51ebf8..1a64cc2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ # rGOSSIS1 -The R package for the GOSSIS-1 ICU mortality predictor +The R package for the GOSSIS-1 ICU mortality predictor. + +This repo is still in development. We are currently working on making the code a little less brittle and improving documentation, particularly including some tutorials and examples. Please make sure to use the most up to date version when using this package. + +To install: + +``` +install.packages("devtools") +devtools::install_github('jraffa/rGOSSIS1') +library(rGOSSIS1) +```