GitHub release (latest by date) GitHub Workflow Status

Bandage-NG

IMPORTANT: This is a fork of original Bandage repo. It may contain new features, new bugs and otherwise be not compatible with the Bandage by Ryan Wick. The documentation, instructions, etc. might be incomplete, missed and inaccurate as well

Intro

Bandage-NG is a GUI program that allows users to interact with the assembly graphs made by de novo assemblers such as SPAdes, MEGAHIT and others.

De novo assembly graphs contain not only assembled contigs but also the connections between those contigs, which were previously not easily accessible. Bandage visualises assembly graphs, with connections, using graph layout algorithms. Nodes in the drawn graph, which represent contigs, can be automatically labelled with their ID, length or depth. Users can interact with the graph by moving, labelling and colouring nodes. Sequence information can also be extracted directly from the graph viewer. By displaying connections between contigs, Bandage opens up new possibilities for analysing and improving de novo assemblies that are not possible by looking at contigs alone.

Help

Bandage-NG documentation is available on the Bandage-NG GitHub wiki.

Bandage-NG help tips are also built into the program. Throughout the UI, you will find these icons next to controls and settings: . Click them to see a description of that element of Bandage.

Prerequisites (for building from the source code)

Qt 6
CMake
C++17-compliant compiler

Pre-built binaries

Pre-built Linux and Mac binaries are available from Releases page.

Building from source

CMake

mkdir build
cd build
cmake ..
make

Contributing

New contributors are welcome! If you're interested or have ideas, please use Issues section in the repo.

Citation

TBD

Credits

Bandage-NG makes use of the OGDF library for performing graph layout algorithms. Big thanks goes out to the OGDF developers for their excellent work!

License

GNU General Public License, version 3

asl / BandageNG

readme