Skip to main content

Provides basic data cleaning, wrangling and plotting of Covid tracking data

Project description

ci-cd codecov Documentation Status

covidtracker

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

Functions

The covidtracker 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 covidtracker. 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 covidtracker. 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 only be directly installed on Mac OS and Linux machines. With Windows machine, because pip install Fiona does not work, you need to install Fiona package first, and then install our covidtracker package.

Mac OS and Linux machine:

$ pip install covidtracker

Windows machine:

$ conda install Fiona
$ pip install covidtracker

Usage

from covidtracker.get_covid_data import get_covid_data
from covidtracker.plot_geographical import plot_geographical
from covidtracker.plot_time_series import plot_ts
from covidtracker.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')

Documentation

Detailed documentation for the package can be found here on Read the Docs : https://covidtracker.readthedocs.io/en/latest/

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

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

Credits

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

covidtracker-0.1.2.tar.gz (31.1 MB view details)

Uploaded Source

Built Distribution

covidtracker-0.1.2-py3-none-any.whl (31.2 MB view details)

Uploaded Python 3

File details

Details for the file covidtracker-0.1.2.tar.gz.

File metadata

  • Download URL: covidtracker-0.1.2.tar.gz
  • Upload date:
  • Size: 31.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for covidtracker-0.1.2.tar.gz
Algorithm Hash digest
SHA256 d3ab4e1d175fb0de2bf315c15b80880c955b897dffe28e550b1b8ea58bd66c96
MD5 d49219d071f31969bb5f2758560a43b8
BLAKE2b-256 c8c0e0f4faec1d58865e13a720d28ff85bdb0c1481da0a7a9be0757abf2c04dc

See more details on using hashes here.

File details

Details for the file covidtracker-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: covidtracker-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 31.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for covidtracker-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 996929f46b89ca381fda384d469b669d57baaf7f4b41abe62e2c1492e85445d9
MD5 ce9302f139c3dae0c0367e2cecfb411a
BLAKE2b-256 fb6f8f385f42dcb1d0881a4acb01ffbd57b6f6ebbff61fb2bb79e28e6d7ffe54

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page