Bayesian Reconstruction of Disease Outbreaks by Combining Epidemiologic and Genomic Data
Bayesian reconstruction of disease outbreaks using epidemiological
and genetic information. Jombart T, Cori A, Didelot X, Cauchemez S, Fraser
C and Ferguson N. 2014. <doi:10.1371/journal.pcbi.1003457>.
outbreaker2: a framework for reconstructing disease outbreaks
Welcome to the project page of outbreaker2, a Bayesian framework for integrating epidemiological and genetic data to reconstruct transmission trees of densely sampled outbreaks. It re-implements, generalises and replaces the model of outbreaker, and uses a modular approach which enables fine customisation of priors, likelihoods and parameter movements (see customisation vignette).
To install the stable version from CRAN:
To install the development version from github (requires Rtools on windows and GSL headers on all platforms):
To add local copies of the vignettes, you will need to specify:
devtools::install_github("reconhub/outbreaker2", build_vignettes = TRUE)
Then, to load the package, use:
outbreaker2 is fully documented on a dedicated website.
It also comes with the following vignettes:
introduction: general introduction using a worked example.
overview: brief overview of the package's content.
customisation: customisation of priors, likelihoods, and movement functions.
Rcpp_API: documentation for the Rcpp API.
See details of contributions here.
Contributions are welcome via pull requests.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Maintainer: Finlay Campbell (email@example.com)
Functions in outbreaker2
|outbreaker||outbreaker2: main function for reconstructing disease outbreaks|
|sim_ctd||Simulate contact data from a transmission tree|
|fake_outbreak||Small simulated outbreak|
|get_cpp_api||Access internal C++ rountines used in outbreaker2|
|create_param||Initializes outputs for outbreaker|
|custom_likelihoods||Customise likelihood functions for outbreaker|
|bind_to_function||Encloses argument in a function's environment|
|create_config||Set and check parameter settings of outbreaker|
|outbreaker_data||Process input data for outbreaker|
|outbreaker_package||outbreaker2: a platform for disease outbreak reconstruction|
|custom_moves||Customise samplers for outbreaker|
|custom_priors||Customise priors for outbreaker|
|chains_pal||Color palettes used in outbreaker|
|print.outbreaker_chains||Basic methods for processing outbreaker results|
Vignettes of outbreaker2
Last month downloads
|License||MIT + file LICENSE|
|Packaged||2018-03-06 17:19:23 UTC; fc1915|
|Date/Publication||2018-03-06 17:52:21 UTC|
Include our badge in your README