Skip to content

Commit

Permalink
DOC: update paper
Browse files Browse the repository at this point in the history
  • Loading branch information
Vini2 committed Aug 16, 2024
1 parent 889cf94 commit 3f7d34a
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@ To address these challenges, GraphBin-Tk integrates the capabilities of GraphBin

GraphBin-Tk can perform stand-alone metagenomic binning using MetaCoAG and bin refinement can be done either using GraphBin or GraphBin2. Additionally, pre-processing functionalities to run these tools and post-processing functionalities to analyse the produced results are included in GraphBin-Tk. A list of the subcommands provided in GraphBin-Tk is as follows:

| Subcommand | Tool/processing functionality | Inputs required |
|-------------|------------------------------------------------------------|-------------------------------------------------------------------------------------------------|
| `graphbin` | Bin refinement tool GraphBin | Contigs, assembly graph file(s)[^1], initial binning result |
| `graphbin2` | Bin refinement tool GraphBin2 | Contigs, assembly graph file(s), initial binning result, coverage of contigs |
| `metacoag` | Binning tool MetaCoAG | Contigs, assembly graph file(s), coverage of contigs |
| `prepare` | Format initial binning results for GraphBin and GraphBin2 | Folder containing the initial binning result |
| `visualise` | Visualise initial and refined binning results on the assembly graph | Assembly graph file(s), initial binning result, final binning result |
| `evaluate` | Evaluate binning results given a ground truth | Binning result, ground truth |
| Subcommand | Tool/processing functionality | Inputs required |
|--------------|------------------------------------------------------------|-------------------------------------------------------------------------------------------------|
| `graphbin` | Bin refinement tool GraphBin | Contigs, assembly graph file(s)[^1], initial binning result |
| `graphbin2` | Bin refinement tool GraphBin2 | Contigs, assembly graph file(s), initial binning result, coverage of contigs |
| `metacoag` | Binning tool MetaCoAG | Contigs, assembly graph file(s), coverage of contigs |
| `prepare` | Format initial binning results for GraphBin and GraphBin2 | Folder containing the initial binning result |
| `visualise` | Visualise initial and refined binning results on the assembly graph | Assembly graph file(s), initial binning result, final binning result |
| `evaluate` | Evaluate binning results given a ground truth | Binning result, ground truth |

[^1]: The assembly graph files can vary depending on the assembler used to generate the contigs. metaSPAdes version requires the assembly graph file `.gfa` format and the paths file `contigs.paths`. MEGAHIT version requires the assembly graph file in `.gfa`. metaFlye version requires the assembly graph file `assembly_graph.gfa` and the paths file in `assembly_info.txt` format.

Expand Down

0 comments on commit 3f7d34a

Please sign in to comment.