lisphilar / covid19-sir

CovsirPhy: Python library for COVID-19 analysis with phase-dependent SIR-derived ODE models.
https://lisphilar.github.io/covid19-sir/
Apache License 2.0
109 stars 43 forks source link

[Deprecate] JapanData class #1179

Closed lisphilar closed 1 year ago

lisphilar commented 1 year ago

Summary of this new feature

DataDownloader().japan_meta() to download metadata in Japan will be created. JapanData class will be deprecated.

CovsirPhy version I used: 2.26.1

lisphilar commented 1 year ago

Could be renamed to .japan() and this will return both of the number of cases and meta data.

lisphilar commented 1 year ago

We can use the dataset regarding the number of cases in Japan with DataDownloader as usual and Japan data including meta data is maintained in this project. https://github.com/lisphilar/covid19-sir/tree/master/data

Most of the users does not use metadata in Japan. The users who use the metadata downloads the data directly without covsiphy.

Functionality of JapanData will be deprecated at the next stable version and will be removed at 3.0.0.

Documentation (README.md in data directory) will be updated.