Skip to main content

Python package to query cancer variant databases

Project description

https://img.shields.io/pypi/v/querynator.svg https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fqbic-pipelines%2Fquerynator%2Fbadge%3Fref%3Dmaster&style=flat-square https://img.shields.io/badge/code%20style-black-000000.svg https://img.shields.io/badge/code%20style-prettier-ff69b4.svg https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336 Documentation Status

Python package to query cancer variant databases

Features

Credits

This package uses the cancergenomeinterpreter.org REST API for data retrieval.

  • Muiños, F., Martínez-Jiménez, F., Pich, O. et al. In silico saturation mutagenesis of cancer genes. Nature 596, 428–432 (2021). https://doi.org/10.1038/s41586-021-03771-1

  • Tamborero, D. Rubio-Perez, C., Deu-Pons, J. et al., Cancer Genome Interpreter annotates the biological and clinical relevance of tumor alterations. Genome Medicine 10, (2018). doi: https://doi.org/10.1101/140475

This package uses the CIViCpy package for data retrieval from the CIViC database.

  • Wagner, Alex H., et al. “CIViCpy: a python software development and analysis toolkit for the CIViC knowledgebase.” JCO Clinical Cancer Informatics 4 (2020): 245-253. doi: https://doi.org/10.1200/CCI.19.00127

  • Griffith, M., Spies, N., Krysiak, K. et al. CIViC is a community knowledgebase for expert crowdsourcing the clinical interpretation of variants in cancer. Nat Genet 49, 170–174 (2017). doi: https://doi.org/10.1038/ng.3774

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Changelog

0.4.2 - Stormy Saturn (2023-04-05)

Added

Fixed

  • Bug fixes to handle new CGI wildtype biomarkers

  • civicpy cache will only be updated when civic is queried

Dependencies

Deprecated

0.4.1 - Stormy Saturn (2023-06-13)

Added

Fixed

  • Bug fixes to include all evidence of CIViC

Dependencies

Deprecated

0.4.0 - Stormy Saturn (2023-05-31)

Added

Fixed

  • Fixed functionality for new CGI file structure

  • Fixed case when CIViC has no hits

Dependencies

Deprecated

0.3.3 - Iron Mercury (2023-05-05)

Added

Fixed

  • Fixed API docs

Dependencies

Deprecated

0.3.2 - Iron Mercury (2023-05-05)

Added

Fixed

  • Fixed version bump

Dependencies

Deprecated

0.3.1 - Iron Mercury (2023-05-05)

Added

Fixed

  • Fixed import of site-packages in setup.py

Dependencies

Deprecated

0.3.0 - Iron Mercury (2023-05-04)

Added

  • Added functionality to combine the results of the Knowledgebases in an HTML report

  • Added possibility to have non-numerical chromosome columns in the input vcf

  • Added deletion of CGI jobs from CGI Server after completion

Fixed

Dependencies

Deprecated

0.2.2 - Sour Venus (2023-03-16)

Added

  • Optional VEP annotation based filtering

  • Additional metadata

  • Usage of pyVCF3 to read vcf files

  • Querynator ID added for filtered vcf files

  • All possible reference genomes for CIViC

Fixed

Dependencies

Deprecated

  • Usage of pysam to read vcf files

0.2.1 - Sour Venus (2023-02-16)

Added

Fixed

  • Rendering API docs

Dependencies

Deprecated

0.2.0 - Sour Venus (2023-02-07)

Added

  • Added functionality to query the Clinical Interpretation of Variants in Cancer (CIViC) Knowledgebase

  • Added possibility to query bgzipped files

Fixed

Dependencies

Deprecated

0.1.3 - Diamond Neptune (2022-11-21)

Added

Fixed

  • Fix including module

Dependencies

Deprecated

0.1.2 - Diamond Neptune (2022-11-18)

Added

Fixed

  • Fix installing requirements

Dependencies

Deprecated

0.1.1 - Methane Titan (2022-11-18)

Added

Fixed

  • Github Actions publishing to PyPI

  • Fix docs

Dependencies

Deprecated

0.1.0 - initial release (2022-11-18)

Added

  • First release on PyPI

  • Created the package template with cookiecutter

  • Functions to query the cancergenomeinterpreter REST API

Fixed

Dependencies

Deprecated

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

querynator-0.4.2.tar.gz (47.1 kB view hashes)

Uploaded Source

Built Distribution

querynator-0.4.2-py3-none-any.whl (44.2 kB view hashes)

Uploaded Python 3

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