Skip to content
Snippets Groups Projects
README.md 648 B
Newer Older
  • Learn to ignore specific revisions
  • Davis McCarthy's avatar
    Davis McCarthy committed
    # sirplus
    
    sirplus is a package for the modeling of COVID-19 spread using stochastic individual compartment models (ICMs). The model implemented extends the classical Susceptible-Infectious-Recovered (SIR) model by adding compartments for Exposed, Quarantined, Hospitalised and Case Fatality individuals. The package provides a simple interface for creating experiments to demonstrate how factors like social-distancing and epidemiological parameters will change the curve.
    
    Christina Azodi's avatar
    Christina Azodi committed
    
    
    ## Installation and vignette
    
    
    Christina Azodi's avatar
    Christina Azodi committed
    To view the vignette install the package then: 
    
    ```
    
    Christina Azodi's avatar
    Christina Azodi committed
    devtools::install(build_vignettes=TRUE)
    
    Christina Azodi's avatar
    Christina Azodi committed
    library(sirplus)
    
    Christina Azodi's avatar
    Christina Azodi committed
    browseVignettes("sirplus")