Skip to content

Commit

Permalink
document commandline access in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeremy McRae committed Apr 19, 2017
1 parent 5b4d22d commit 01d769e
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ Install shabam:
pip install git+git://github.com/dlrice/shabam.git --user
```


## The dream
```py
from shabam import seqplot
Expand All @@ -30,7 +29,18 @@ seqplot('example.bam', chrom='1', start=30243, end=30321,
- export PDF, PNG, SVG or PS formatted plots with matching filename extensions
- seqplot returns PNG data if you don't include an output filename

## Improvements to realize the dream
### Command line version
```sh
./bin/shabam.py \
--seqfiles example.bam \
--chrom 2 \
--start 30243 \
--end 30321 \
--fastafile reference.fasta \
--out plot.svg
```

## Further improvements to the dream
- [ ] Use consensus sequence when we don't provide a reference sequence
- [ ] Allow custom colors
- [ ] Compute proportion of variants at any site
Expand Down

0 comments on commit 01d769e

Please sign in to comment.