search

signaturescience / fiphde

Forecasting Influenza in Support of Public Health Decision Making
https://signaturescience.github.io/fiphde/
GNU General Public License v3.0
3 stars 1 forks source link

investigate fiphde:::hospitalizations data retrieval for specific surveillance areas #194

Closed vpnagraj closed 8 months ago

vpnagraj commented 9 months ago

it looks as though the fiphde::hospitalizations() is currently only retrieving the "default_data" from the HTTP request response:

https://github.com/signaturescience/fiphde/blob/main/R/retrieve.R#L633

that default data appears to be the same regardless of the arguments you pass:

https://signaturescience.github.io/fiphde/reference/hospitalizations.html#arguments

even though this is an unexported helper, we should update the documentation accordingly. and if there is a way to make the function more flexible we should.

vpnagraj commented 8 months ago

i've addressed this by adding some clarifying documentation to note this limitation in the hospitalizations() helper function. noting that this is not exported and the get_cdc_hosp() function that internally uses this helper actually doesnt have an option to look for specific surveillance areas (i.e., it already defaults to the entire network, which is working)