From cd74a24461d86edbe49fbdee7fb82e1faafa5295 Mon Sep 17 00:00:00 2001 From: Louis-Philippe Lemieux Perreault Date: Fri, 21 Aug 2020 11:48:44 -0400 Subject: [PATCH] Updated README --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d0bc5d5..3af8497 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,19 @@ +# pybgen - Module to process BGEN files + [![Build Status](https://travis-ci.org/lemieuxl/pybgen.svg?branch=master)](https://travis-ci.org/lemieuxl/pybgen) [![Coverage Status](https://coveralls.io/repos/github/lemieuxl/pybgen/badge.svg?branch=master)](https://coveralls.io/github/lemieuxl/pybgen?branch=master) [![PyPI version](https://badge.fury.io/py/pybgen.svg)](http://badge.fury.io/py/pybgen) - -# pybgen - Module to process BGEN files - `PyBGEN` is a Python module to read and write BGEN binary files and extract dosage data. A short documentation is available at [https://lemieuxl.github.io/pybgen/](https://lemieuxl.github.io/pybgen/). - ## Dependencies The tool requires a standard [Python](http://python.org/) installation (2.7 and -3.4 or higher are supported) with the following modules: +3.6 or higher are supported) with the following modules: 1. [numpy](http://www.numpy.org/) version 1.12.0 or latest 2. [six](https://pythonhosted.org/six/) version 1.10.0 or latest @@ -23,7 +21,6 @@ The tool requires a standard [Python](http://python.org/) installation (2.7 and The tool has been tested on *Linux*, but should work on *MacOS* and *Windows* operating systems as well. - ## Installation Using `pip`: @@ -46,7 +43,6 @@ To add the channel, perform the following command: conda config --add channels http://statgen.org/wp-content/uploads/Softwares/pybgen ``` - ### Updating To update the module using `pip`: @@ -65,7 +61,6 @@ conda update pybgen conda update pybgen -c http://statgen.org/wp-content/uploads/Softwares/pybgen ``` - ## Testing To test the module, just perform the following command: @@ -78,9 +73,10 @@ $ python -m pybgen.tests ...................................................................... ...................................................................... ...................................................................... -............................................ +...................................................................... +...................................... ---------------------------------------------------------------------- -Ran 464 tests in 19.772s +Ran 528 tests in 13.171s OK ```