Skip to main content

Python version of R gsalib to read GATK Report tables into pandas DataFrames

Project description

gsalib makes it easy for Python users to analyze metrics reports created by the Broad Institute’s Genome Analysis Toolkit (GATK). The Broad provides an R library called gsalib that allows you to load GATKReport files into R for further analysis (https://gatkforums.broadinstitute.org/gatk/discussion/1244/what-is-the-gatkreport-file-format). Python gsalib is an adaptation of the R libray that allows you to load GATKReport files into Python/pandas DataFrames.

Neither the R nor Python versions of gsalib support the samtools.metrics reports created by Picard Tools. To analyze Picard reports with Python, consider using the picard.parse function in the Crimson module.

Features

  • Enables analysis of GATK reports with powerful pandas DataFrames and plotting

  • Reads GATKReport versions 0.x and 1.x

  • Compatible with Python >=2.7 and >=3.4

Installation

Install gsalib by running

pip install gsalib

Example

Read a report and get a table’s DataFrame:

from gsalib import GatkReport

report = GatkReport('/path/to/gsalib/test/test_v1.0_gatkreport.table')
table = report.tables['ExampleTable']

Documentation

https://gsalib.readthedocs.io/en/latest/

Contribute

License

The project is licensed under the MIT license.

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

gsalib-1.0.6.tar.gz (23.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gsalib-1.0.6-py2.py3-none-any.whl (7.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file gsalib-1.0.6.tar.gz.

File metadata

  • Download URL: gsalib-1.0.6.tar.gz
  • Upload date:
  • Size: 23.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for gsalib-1.0.6.tar.gz
Algorithm Hash digest
SHA256 43ce95242625826f5b339f7e250a0a259e78af4a821300f75dfcf470e590a0e1
MD5 3a9e54eab6450511b2118b5ed376788d
BLAKE2b-256 2b92ee3f35c37df93752985c1fdb03579cbd18ffd2f356228ecf1d5fa4e8d989

See more details on using hashes here.

File details

Details for the file gsalib-1.0.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for gsalib-1.0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 00e59671709beb8859686d584075fa4a1f19a0a23002094ccb5e6256c5d2237b
MD5 5701218d5183e93ed0cdd90c2a5d25b9
BLAKE2b-256 b16262883a6e4c8671a28a4bbc7b7119e11274c86e77a8dafa88d75fbeda2b41

See more details on using hashes here.

Supported by

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