search

rrwick / Bandage

a Bioinformatics Application for Navigating De novo Assembly Graphs Easily
http://rrwick.github.io/Bandage/
GNU General Public License v3.0
585 stars 98 forks source link

readme

BandageBandage

Table of Contents

2022 update

Bandage is now about seven years old! Despite its popularity, I sadly don't have the time to give it the attention it deserves. Also, its codebase is too large and my C++/Qt skills are too rusty for me to make anything more than trivial changes.

I'm not declaring Bandage completely abandoned, because I still think it's a useful tool, but don't expect a lot development or support on this repo. I will, however, strive to ensure that Bandage continues to run well on modern systems. E.g. I released v0.9.0 in January 2022, which compiles using modern versions of Qt and runs natively on Apple Silicon Macs.

A number of enterprising users have forked Bandage, so if you’re after a specific new feature, you might find it implemented in one of the forks, the most active of which is BandageNG.

Intro

Bandage is a GUI program that allows users to interact with the assembly graphs made by de novo assemblers such as Velvet, 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.

More information and download links are on the Bandage website: rrwick.github.io/Bandage

Help

Bandage documentation is available on the Bandage GitHub wiki.

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

Pre-built binaries

Compiled 64-bit binaries for Ubuntu Linux, CentOS, macOS and Windows are available in the GitHub 'Releases' section and from the Bandage website.

If you download and run the Mac binary, you may receive a warning stating that Bandage 'can't be opened because it is from an unidentified developer' or 'is damaged and can't be opened'. Right click on the file and select 'Open' to override this warning. If that doesn't work, clear the quarantine extended attribute via the command line with xattr -cr Bandage.app.

The Linux binaries come in two varieties: dynamically-linked and statically-linked. The dynamically-linked binary is preferable, but it has more dependencies (like Qt 5). If you experience problems with the dynamically-linked binary, please try the statically-linked version instead.

Building from source

If the compiled binaries do not work for you, you can build Bandage on most common OSs using Qt:

  1. Make sure you have a compiler and other common developer tools set up.
    • For macOS, this means Xcode and its command line tools.
    • For Ubuntu: sudo apt install build-essential git libgl1-mesa-dev libxcb-xinerama0
  2. Install the Qt SDK with version 5.15 or later. Double check that you install a version compatible with your OS (Qt 5 supported platforms and Qt 6 supported platforms).
  3. Clone the Bandage code from GitHub: git clone https://github.com/rrwick/Bandage.git
  4. Open the Qt Creator program and load the Bandage.pro file which is in the Bandage directory. Since this is the first time the project has been loaded, it will ask you to configure the project. The defaults should be okay, so click 'Configure Project'.
  5. Change to the release build configuration by clicking where it says 'Debug' in the bottom left area of Qt Creator and select 'Release'.
  6. Build and run Bandage by clicking the green arrow in the bottom left area of Qt Creator. Bandage should open when the build has finished.
  7. You will find the executable file in a new folder that begins with 'build-Bandage-Desktop'.

Contributing

New contributors are welcome! If you're interested or have ideas, please contact me (Ryan) at rrwick@gmail.com.

Citation

If you use Bandage in your research, please cite the following publication:

Wick R.R., Schultz M.B., Zobel J. & Holt K.E. (2015). Bandage: interactive visualisation of de novo genome assemblies. Bioinformatics, 31(20), 3350-3352.

Credits

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

I also thank Rayan Chikhi and Elmar Pruesse for their contributions to the code.

License

GNU General Public License, version 3