Metadata-Version: 2.1
Name: bgen-reader
Version: 4.0.0
Summary: Bgen file format reader
Home-page: https://github.com/limix/bgen-reader-py
Author: Danilo Horta
Author-email: horta@ebi.ac.uk
Maintainer: Danilo Horta
Maintainer-email: horta@ebi.ac.uk
License: MIT
Download-URL: https://github.com/limix/bgen-reader-py
Description: # bgen-reader
        
        [![Travis](https://travis-ci.com/limix/bgen-reader-py.svg?branch=master)](https://travis-ci.com/limix/bgen-reader-py) [![Documentation](https://readthedocs.org/projects/bgen-reader/badge/?version=latest)](https://bgen-reader.readthedocs.io/en/latest/?badge=latest)
        
        A [bgen file format](http://www.well.ox.ac.uk/~gav/bgen_format/) reader.
        
        Bgen is a file format for storing large genetic datasets.
        It supports both unphased genotypes and phased haplotype data with variable
        ploidy and number of alleles. It was designed to provides a compact data
        representation without sacrificing variant access performance.
        
        This python package is a wrapper around the [bgen library](https://github.com/limix/bgen),
        a low-memory footprint reader that efficiently reads bgen files.
        It fully supports the bgen format specifications: 1.2 and 1.3;
        as well as their optional compressed formats.
        
        ## Install
        
        It can be installed via [conda](https://conda.io/docs/)
        
        ```bash
        conda install -c conda-forge bgen-reader
        ```
        
        Or via pip
        
        ```bash
        pip install bgen-reader
        ```
        
        ## Documentation
        
        Please, refer to [https://bgen-reader.readthedocs.io](https://bgen-reader.readthedocs.io).
        
        
        ## Troubleshooting
        
        ### fatal error: bgen.h: No such file or directory
        
        This means that bgen C library is not installed (or could not be found). Please,
        follow the instructions in <https://github.com/limix/bgen> to install it, and try
        installing bgen-reader again.
        
        ## Problems
        
        If you encounter any issue, please, [submit it](https://github.com/limix/bgen-reader-py/issues/new).
        
        ## Authors
        
        * [Danilo Horta](https://github.com/horta)
        
        ## License
        
        This project is licensed under the [MIT License](https://raw.githubusercontent.com/limix/bgen-reader-py/master/LICENSE.md).
        
Keywords: bgen,reader,genetics
Platform: Windows
Platform: MacOS
Platform: Linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
