signaturescience / rplanes

R package to conduct plausibility analysis of epidemiological signals
https://signaturescience.github.io/rplanes/
Other
8 stars 2 forks source link

add example data #15

Closed vpnagraj closed 1 year ago

vpnagraj commented 1 year ago

we need some example observed and forecasted data to include in the package

this will be helpful for vignettes, examples, and tests

vpnagraj commented 1 year ago

some more color/suggestions on this topic ...

lets try to put together example data for both observed and forecasts. for observed, it would be useful to have differing temporal resolutions (ideally examples of daily, weekly, and monthly). noting that we can aggregate up if need be (e.g., take daily data and aggregate to monthly).

but there are some data sources we can start with out of the box:

dont forget to check licenses.

note that i had considered the WNV forecast data but it looks like while forecasts are available, the observed data requires a usage agreement: https://github.com/cdcepi/WNV-forecast-project-2023

last thing. we can (and probably will) include some of this data in inst/extdata and as an internal data set (i.e., like this: https://github.com/signaturescience/rplanes/blob/main/data-raw/generate_sysdata.R). going to depend on the dataset and how we use it in examples / tests. my instinct for now is to include the forecast files in inst/extdata but observed data (like HHS Protect data with data-raw method)

@dwill023 assigning to you start. let me know if you have any questions along the way.

dwill023 commented 1 year ago

@vpnagraj so I have prepared some raw data and did see that WNV surveillance data does require a data request form for the 2023 and previous years data. Also the other repos on dengue and zika didn't contain forecast only surveillance data. So perhaps just take another group's Flusight-forecast-data?

dwill023 commented 1 year ago

Script to generate example data is in getting_data.R. All of which is saved as csv files in branch rplanes-dw /inst/extdata. @vpnagraj let me know if all looks good and I can create a pull request to merge.

vpnagraj commented 1 year ago

@dwill023 yeah i went through and made a few edits. you can see them in the list of commits in the (now merged) PR (https://github.com/signaturescience/rplanes/pull/20)

we'll talk through those more soon ... closing this issue for now. we can re-open later if need be.