Skip to content

Getting started

Linelle edited this page Jul 11, 2022 · 13 revisions

Descriptions and images/animations featured here are credited to Ryan Wick from the extensive original Bandage documentation!

Finding a path by name in a graph

Paths (P lines in GFA 1.2) represent named ways of walking segments in a graph. An example of a path can be a scaffold that resulted from downstream scaffolding such as Bionano Solve, SALSA2, or yahs. The segments in a path are connected by jumps (J lines in GFA 1.2). These are represented in the above animation by dashed red lines†.

BandageNG allows users to look up paths by name, and has an autofill function based on the paths defined in the GFA. Once a path is selected, the user can move all of the path's components as one.

† Not to be confued with overlap links (L lines), represented by solid black lines.

Load a graph

Load a graph by following these options from the top menu bar: File > Load graph


Image credit: Ryan Wick

There are test GFA files available in the [Bandage-NG github repo's inputs folder](https://github.com/asl/BandageNG/tree/dev/tests/inputs): `test_gfa12.gfa`, `test_rgfa.gfa`. These files are included if you downloaded the source code, but may need to be downloaded if you only downloaded the executable binaries.

Draw a graph

Once the graph is loaded, click the Draw graph button on the left sidebar to draw the graph to the screen.


Image credit: Ryan Wick

This step can take some time depending on the size of the graph. The visual appearance of the layout is seeded based on current time. so the graph may appear different if you redraw it in the future.

Controls (section the same as original Bandage)

Note that on a Mac, the Command key (⌘) is used instead of the Ctrl key in the below instructions.

Selection

Click on any node or edge to select it.


Image credit: Ryan Wick

Holding `Ctrl` while clickon on nodes/edges adds them or removes them from the current selection..


Image credit: Ryan Wick

Click and drag to select large numbers of nodes and edges.


Image credit: Ryan Wick

Moving nodes

Left click and drag on any node to move it. For short nodes, this will move the entire node. For long nodes, this will move the region of the node near the mouse cursor.


Image credit: Ryan Wick

Right cilck and drag o nany node to move it one piece at a time. This is useful for fine-tuning the shape of a graph or for rotating short nodes.


Image credit: Ryan Wick

Selected nodes are moved in their entirety when dragged. If multiple nodes are selected, they can all be moved together.


Image credit: Ryan Wick

Mouse navigation

Ctrl + mouse wheel to zoom the view in and out.


Image credit: Ryan Wick

Ctrl + left mouse button click + drag to pan the view.


Image credit: Ryan Wick

Ctrl + right mouse button click + drag to rotate the view.


Image credit: Ryan Wick