vg::Path Struct Reference

Public Attributes
string	name = 1
	The name of the path. Path names starting with underscore (_) are reserved for internal VG use. More...
repeated< Mapping >	mapping = 2
	The Mappings which describe the order and orientation in which the Path visits Nodes. More...
bool	is_circular = 3
	Set to true if the path is circular. More...
int64	length = 4
	Optional length annotation for the Path. More...

Detailed Description

Paths are walks through nodes defined by a series of Edits. They can be used to represent:

• haplotypes
• mappings of reads, or alignments, by including edits
• relationships between nodes
• annotations from other data sources, such as: genes, exons, motifs, transcripts, peaks

Member Data Documentation

is_circular

bool vg::Path::is_circular = 3

Set to true if the path is circular.

length

int64 vg::Path::length = 4

Optional length annotation for the Path.

mapping

repeated<Mapping> vg::Path::mapping = 2

The Mappings which describe the order and orientation in which the Path visits Nodes.

name

string vg::Path::name = 1

The name of the path. Path names starting with underscore (_) are reserved for internal VG use.

---

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

• deps/libvgio/deps/vg.proto