Metadata-Version: 2.1
Name: bammix
Version: 1.0.0
Summary: bammix
Home-page: https://github.com/chrisruis/bammix
Author: Chris Ruis
Author-email: cr628@cam.ac.uk
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
License-File: LICENSE

# bammix
Summarise nucleotide counts at a set of positions in a BAM file to search for mixtures

<img src="./docs/nucleotide_plot.png" width = "700">

### Usage
```
usage: bammix -b bam_file.bam -p positions [options]

bammix

optional arguments:
  -h, --help            show this help message and exit
  -b BAM, --bam BAM     BAM file to be examined
  -p POSITIONS [POSITIONS ...], --positions POSITIONS [POSITIONS ...]
                        Set of positions to be checked
  -r REFERENCE, --reference REFERENCE
                        Name of reference the reads were mapped against, default MN908947.3
  -q BASE_QUALITY, --base_quality BASE_QUALITY
                        Minimum base quality to include a base in counts, default is to include all bases regardless of quality
  -m MAPPING_QUALITY, --mapping_quality MAPPING_QUALITY
                        Minimum mapping quality to include a read in counts, default is to include all reads
  -o O                  Optional prefix for output files, default is no prefix
```

### Install
```
pip install bammix
```


