Skip to content

Commit

Permalink
Example -> Usage
Browse files Browse the repository at this point in the history
  • Loading branch information
AssafSternberg committed Feb 1, 2024
1 parent 2bef8bd commit ac1fbec
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions modo/cram.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
def slice(cram_path: AlignmentFile, coords: str) -> AlignmentFile:
"""Return a slice of the CRAM File as an iterator object.
Examples
--------
Usage:
-----
>>> x = slice("data/ex1/demo1.cram", "chr1:100-200")
>>> for read in x:
print(read)
print(read)
"""

# split up coordinate string "chr:start-end" into its three elements
Expand Down

0 comments on commit ac1fbec

Please sign in to comment.