jessie14 / group28-covidtracker

covid_tracker

Provides basic data cleaning, wrangling and plotting of Covid tracking data in Canada.

Functions

The covid_tracker package is designed for the easy retrieval and analysis of data pertaining to Covid trends in Canada, including information about cases, vaccinations and testing. The package serves as a wrapper for the opencovid.ca API, and provides additional helper functions for visualising the data, either as a time series or in the form of a map.

• get_covid_data()

  Retrieve cleaned and formatted data of specified type and within (optionally) provided time ranges and locations

• plot_time_series()

  Function for plotting time series trends in Covid data

• calculate_stat_summary()

  Function for returning key statistical information about Covid data, such as long run trends and comparisons between provinces
  

• plot_geographical()

  Function for plotting chloropleth maps with Covid data

Similar Packages

There are currently no other Python packages available that can perform the same set of data retrieval and analysis functionalities as covid_tracker. There are several packages that have similar functionality, but are most are tailored either towards covid data retrieval or data visualization. The packages designed for covid data retrieval also do not use the same data source as covid_tracker. Some examples of related Python packages useful for Covid data retrieval and data visualizations include:

• covid19dh - For Covid data retrieval
• covid- For Covid data retrieval
• folium - For data visualizations
• plotly - For data visualizations

Installation

Please note that due to GDAL dependencies, the package can be installed on Mac OS and Linux machines, but currently does not work on Windows machines.

$ pip install git+https://github.com/UBC-MDS/Group28-covid_tracker

Usage

from covid_tracker.get_covid_data import get_covid_data
from covid_tracker.plot_geographical import plot_geographical
from covid_tracker.plot_time_series import plot_ts
from covid_tracker.calculate_stat_summary import calculate_stat_summary

covid_df = get_covid_data('active')
plot_map = plot_geographical(covid_df,'cumulative_deaths')
plot_ts = plot_ts(covid_df, "active_cases")
summary = calculate_stat_summary(covid_df, 'active')

Contributing

We welcome and recognize all contributions. Please see contributing guidelines in the Contributing document. This repository is currently maintained by

• Cuthbert Chow (@cuthchow)
• Tianwei Wang (@Davidwang11)
• Siqi Tao (@SiqiTao)
• Jessie Wong (@jessie14)

License

covid_tracker was created by Group 28. It is licensed under the terms of the MIT license.

Credits

covid_tracker was created with cookiecutter and the py-pkgs-cookiecutter template.