Skip to content

Commit 925dabb

Browse files
authored
Update README.md
Address the issue in #29, #31, and #38
1 parent 87cadee commit 925dabb

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
@@ -73,7 +73,14 @@ More examples can be found in the [readthedocs tutorial](https://harvest.readthe
7373
* `parsnp.tree` is the resulting phylogeny.
7474
* If run in partition mode, Parsnp will produce a `partition` folder in the output directory, which contains the output of each of the partitioned runs.
7575

76+
### XMFA format
77+
The output XMFA file contains a header section mapping contig names to indices. Following the header section, the LCBs/clusters are reported in the XMFA format, where the ID for each record in an LCB is formatted as:
7678

79+
```
80+
[fileidx]:[concat_start]-[concat_end] [strand] cluster[x] s[contig_idx]:p[contig_pos]
81+
```
82+
83+
The `concat_start` and `concat_end` values are internal to parsnp. The sequence for this record can be found in the file at index `fileidx` (these are declared at the top of the xmfa) on the `contig_idx`th contig starting at position `contig_pos`.
7784

7885
## Misc
7986

0 commit comments

Comments
 (0)