vg
tools for working with variation graphs
Public Attributes | List of all members
vg::SnarlTraversal Struct Reference

Public Attributes

repeated< Visitvisit = 1
 
string name = 2
 

Detailed Description

Describes a walk through a Snarl where each step is given as either a node or a child Snarl (leaving the walk through the child Snarl to another SnarlTraversal)

Member Data Documentation

◆ name

string vg::SnarlTraversal::name = 2

The name of the traversal can be used for a variant allele id (e.g. <parentSnarlHash>_0, <parentSnarlHash>_1... or by some other arbitrary annotation , unique or non-unique, e.g. deleteterious, gain_of_function, etc., though these will be lost in any indices).

◆ visit

repeated<Visit> vg::SnarlTraversal::visit = 1

Steps of the walk through a Snarl, including the start and end nodes. If the traversal includes a Visit that represents a Snarl, both the node entering the Snarl and the node leaving the Snarl should be included in the traversal.


The documentation for this struct was generated from the following file: