Skip to content

Commit 4589ed7

Browse files
Add note on handling compressed PAF files and GZI indexing for improved performance
1 parent 9c5c02e commit 4589ed7

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,13 @@ impg index -p alignments.paf -i custom.impg
281281
impg index --paf-list paf_files.txt
282282
```
283283

284+
**Note on compressed PAF files**: `impg` works directly with bgzip-compressed PAF files (`.paf.gz`, `.paf.bgz`). For large files, creating a GZI index can speed up initial index creation:
285+
286+
```bash
287+
bgzip -r alignments.paf.gz # Creates alignments.paf.gz.gzi (optional)
288+
```
289+
290+
If a `.gzi` file is present, `impg` will automatically use it for faster multithreaded decompression.
284291

285292
### Common options
286293

0 commit comments

Comments
 (0)