knitr::opts_chunk$set( collapse = TRUE, comment = "#>", fig.align = "center", fig.path = "man/figures/README-", echo = TRUE, fig.width = 8, fig.height = 6 )
This package compiles a series of publicly available disease outbreak data. Data can be provided as R objects (loaded automatically when loading the package), text files distributed alongside the package, or functions generating a dataset.
The following R datasets are currently available:
if(!require(printr)) warning("printr is not installed; displaying the content of 'data(...)' may not work")
data(package="outbreaks")
To install the current stable, CRAN version of the package, type:
install.packages("outbreaks")
To benefit from the latest features and bug fixes, install the development, github version of the package using:
devtools::install_github("reconverse/outbreaks")
Note that this requires the package devtools installed.
We will try to create a better repository and data submission system at a later stage.
The purpose of the current package is only to share examplar datasets during the hackathon.
Acceptable forms are:
- as a .RData
files in the data/
folder (recommended)
- as a text file in the inst/
folder
- as a function loading/assembling/simulating a dataset
We use the lower case throughout, and snake_case (using underscores) to separate words for the files and dataset names, so that for a RData
object, a new dataset woud look like: `my_new_data_RData'. Try using informative names, typically using the disease first. Whenever available, order fields as:
1. disease: mandatory
2. location: optional
3. year: optional
4. sim: mandatory if this is a simulated dataset; otherwise data is assume to be an actual outbreak
5. other: (any other relevant information)
Maintainer: Finlay Campbell (finlaycampbell93@gmail.com)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.