Metadata-Version: 1.2
Name: varianteval
Version: 0.0.2
Summary: Library to help compare VCF files
Home-page: https://broadinstitute.github.io/varianteval/
Author: Kiran V Garimella
Author-email: kiran@broadinstitute.org
License: BSD 3-Clause
Description: varianteval
        """""""""""
        
        |GitHub release| |PyPI version varianteval|
        
        .. |GitHub release| image:: https://img.shields.io/github/release/broadinstitute/varianteval.svg
           :target: https://github.com/broadinstitute/varianteval/releases/
        
        .. |PyPI version varianteval| image:: https://img.shields.io/pypi/v/varianteval.svg
           :target: https://pypi.python.org/pypi/varianteval/
        
        ``varianteval`` is a Python library to facilitate the comparison of one or more VCFs against each other and/or truth datasets.
        
        Installation
        ------------
        
        ``pip`` is recommended for ``varianteval`` installation.
        
        ::
        
           pip install varianteval
        
        To install from Github source for development, the following commands can be run.
        
        ::
        
           git clone https://github.com/broadinstitute/varianteval.git
           pip install -e varianteval/
        
        Getting Started
        ---------------
        
        Don't! This API is currently in pre-pre-alpha form. Unless you're helping to developing this library, don't use it for anything!
        
        Getting help
        ------------
        
        The `varianteval documentation page <https://broadinstitute.github.io/varianteval/>`_ provides detailed descriptions of API usage and algorithmic details. If you encounter bugs or have questions/comments/concerns, please file an issue on our `Github page <https://github.com/broadinstitute/varianteval/issues>`_.
        
        Developers' guide
        -----------------
        
        For information on contributing to ``varianteval`` development, visit our `developer documentation <DEVELOP.md>`_.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.6
