Giter Club home page Giter Club logo

outbreaks's Introduction

R-CMD-check CRAN_Status_Badge CRAN Downloads Downloads from Rstudio mirror


outbreaks: a compilation of disease outbreak data

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:

data(package="outbreaks")
Item Title
covid19_england_nhscalls_2020 Potential COVID19 cases reported through NHS pathways
dengue_fais_2011 Dengue on the island of Fais, Micronesia, 2011
dengue_yap_2011 Dengue on the Yap Main Islands, Micronesia, 2011
ebola_kikwit_1995 Ebola in Kikwit, Democratic Republic of the Congo, 1995
ebola_sierraleone_2014 Ebola in Sierra Leone, 2014
ebola_sim Simulated Ebola outbreak
ebola_sim_clean Simulated Ebola outbreak
fluH7N9_china_2013 Influenza A H7N9 in China, 2013
influenza_england_1978_school Influenza in a boarding school in England, 1978
measles_hagelloch_1861 Measles in Hagelloch, Germany, 1861
mers_korea_2015 Middle East respiratory syndrome in South Korea, 2015
nipah_malaysia Nipah in Malaysia and Sinagapore, 1997-1999
norovirus_derbyshire_2001_school Norovirus in a primary school in Derbyshire, England, 2001
rabies_car_2003 Dog Rabies in Central African Republic, 2003-2012
s_enteritidis_pt59 Salmonella Enteritidis PT59 outbreak
sars_canada_2003 Severe Acute Respiratory Syndrome in Canada, 2003
sarscov2_who_2019 SARS-CoV-2 World Health Organization Situation Reports 2019 Outbreak (COVID-19)
smallpox_abakaliki_1967 Smallpox in Abakaliki, Nigeria, 1967
varicella_sim_berlin Simulated Varicella outbreak
zika_girardot_2015 Zika in Girardot, Colombia, 2015
zika_sanandres_2015 Zika in San Andres, Colombia, 2015
zika_yap_2007 Zika on the Yap Main Islands, Micronesia, 2007

Data sets in outbreaks


Installing the package

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.


Add your own data!

How to add data?

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

Naming Conventions

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)


Contributors (by alphabetic order):

Maintainer: Finlay Campbell ([email protected])

outbreaks's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

outbreaks's Issues

Add norovirus.derbyshire.2001.school

These data come from an outbreak of norovirus in summer 2001 in a primary school and nursery in Derbyshire, England, and were analysed by O'Neill and Marks (2005). As described in the paper, out of a total of 492 children in the school, 186 were absent from school with gastrointestinal symptoms. The school was cleaned on days 13 and 14, and on days 20 and 21, both of which were weekends, and the school was shut on days 18 and 19. Following the second cleaning, there were no further absences, although three children reported symptoms on day 22, the last day of the outbreak.

The raw data were kindly provided by Philip O'Neill, and can be found here.

It is in the format:
Class, 1st day absent, start of illness, end of illness, day of vomiting in school

There are 15 classes in the school.

COVID-19

I've been transcribing the daily WHO Situation Reports for the current COVID-19 outbreak (https://github.com/eebrown/data2019nCoV). I think your R package outbreaks could be a good home for the data eventually. I'd be happy to add it, possibly after the outbreak has started to settle and the data isn't updated so frequently?

look for other non-consistent cases

For instance:

> names(ebola_sim$linelist)
[1] "case.id"                 "generation"             
[3] "date.of.infection"       "date.of.onset"          
[5] "date.of.hospitalisation" "date.of.outcome"        
[7] "outcome"                 "gender"                 
[9] "hospital"               

We will need to coordinate the release of the next version with a new one of incidence, as it will otherwise break compatibility.

Fix package

As of 0722bb3 I get:

> check()
Updating outbreaks documentation
Loading outbreaks
Invalid DESCRIPTION:
Malformed maintainer field.

See section 'The DESCRIPTION file' in the 'Writing R Extensions'
manual.

Setting env vars ---------------------------------------------------------------
CFLAGS  : -Wall -pedantic
CXXFLAGS: -Wall -pedantic
Building outbreaks -------------------------------------------------------------
'/usr/local/lib/R/bin/R' --no-site-file --no-environ --no-save --no-restore  \
  --quiet CMD build '/home/thibaut/dev/RECON/outbreaks' --no-resave-data  \
  --no-manual 

* checking for file/home/thibaut/dev/RECON/outbreaks/DESCRIPTION... OK
* preparingoutbreaks:
* checking DESCRIPTION meta-information ... ERROR
Malformed maintainer field.

See section 'The DESCRIPTION file' in the 'Writing R Extensions'
manual.

Error: Command failed (1)

@finlaycampbell make sure to run devtools::check() whenever you push to a master branch of a functional package. This one is probably a typo but it prevents the package from being installed.

> install()
Installing outbreaks
'/usr/local/lib/R/bin/R' --no-site-file --no-environ --no-save --no-restore  \
  --quiet CMD INSTALL '/home/thibaut/dev/RECON/outbreaks'  \
  --library='/home/thibaut/R/x86_64-pc-linux-gnu-library/3.3' --install-tests 

* installing *source* packageoutbreaks...
Error : Invalid DESCRIPTION file

Malformed maintainer field.

See section 'The DESCRIPTION file' in the 'Writing R Extensions'
manual.

ERROR: installing package DESCRIPTION failed for packageoutbreaks* removing/home/thibaut/R/x86_64-pc-linux-gnu-library/3.3/outbreaks* restoring previous/home/thibaut/R/x86_64-pc-linux-gnu-library/3.3/outbreaksError: Command failed (1)

submit new version to CRAN?

Given that the version on CRAN is almost two years old, maybe it's time to submit the update with the two new(ish) data sets?

submit new version to CRAN

Make sure to increment the version number to reflect new features (middle number), pass the check, and submit to CRAN. There is a new dataset in there we are using in packages under development.

Release on CRAN!

The package is used for examples throughout other RECON packages, so we need to get it on CRAN before making any other release (incidence is ready to go).

We need to go through our own guidelines:
http://www.repidemicsconsortium.org/resources/guidelines/

But most of it will be made easier as there's no code in this package.

@finlaycampbell lemme know if you have questions at any point; we also now have a slack for RECONHUB - I just invited you:
https://reconhub.slack.com/messages/general/

Make script for adding / documenting new RData

New data submission is manual so far. It may be useful to have a function of the type:
submit.data(foo)
where foo is a new dataset, which would generate:

  • foo.RData: a compressed R object to be added to data/ (best compression possible by default)
  • foo.R: a template of roxygen2 documentation for dataset foo

Optionally, the user could be prompted to populate some fields (provided as arguments defaulting to NULL).

Use snake_case throughout

I'm already hating myself for this, but as snake_case has become the standard in other RECON packages it would make sense to renamed our datasets and variables within datasets. Probably best done before too many packages depend on outbreaks too.

release current version

The version on CRAN still is using dots in names. We need to release the current one otherwise packages depending on this will break further down the line (thinking about first release of epicontacts for instance).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.