Skip to content

Commit

Permalink
Updates README.md with details on how FMindexing removes artificially…
Browse files Browse the repository at this point in the history
… generated sequences.

Former-commit-id: ecfc3d3
  • Loading branch information
samhorsfield96 committed Jan 15, 2021
1 parent 8e88c41 commit b7c9179
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,19 @@ ggCaller can take a list of fasta files (one file per line), or a Bifrost GFA fi

To run ggCaller from the command line, pass arguments specifying input/output and parameters for traversal.

ggCaller additionally employs FMindexing to remove artificial sequences generated by incorrectly phased nodes in the DBG. This is only employed when the input sequences are exclusively assembled genomes.

#### If Bifrost GFA and Colours file already exist:

To run ggCaller using an existing Bifrost GFA file and Colours file, specify BOTH:
- ```--graph <graph.gfa>``` Input GFA
- ```--colours <colours.bfg_colors>``` Input colours file

Note: Ensure the sequences used to build the graph are in the same directories as when the graph was built. If the sequences you used to generate the GFA and Colours files were exclusively assembled genomes, additionally specify:
To enable filtering of artificially generated sequences via FMindexing (if sequences used to generate the GFA and Colours files were exclusively assembled genomes), additionally specify:
- ```--is-ref```

Note: Ensure the sequences used to build the graph are in the same directories as when the graph was built.

#### If Bifrost GFA and Colours file do not exist:

To build a new Bifrost graph using assembled genomes and/or reads, specify ONE OR BOTH:
Expand Down

0 comments on commit b7c9179

Please sign in to comment.