vg
tools for working with variation graphs
Public Member Functions | Public Attributes | Protected Attributes | List of all members
vg::RareVariantSimplifier Class Reference

#include <rare_variant_simplifier.hpp>

Inheritance diagram for vg::RareVariantSimplifier:
vg::Progressive

Public Member Functions

 RareVariantSimplifier (MutablePathDeletableHandleGraph &graph, VcfBuffer &variant_source)
 
void simplify ()
 Simplify the graph. More...
 
- Public Member Functions inherited from vg::Progressive
void preload_progress (const string &message)
 
void create_progress (const string &message, long count)
 
void create_progress (long count)
 
void update_progress (long i)
 
void increment_progress ()
 
void destroy_progress (void)
 

Public Attributes

double min_frequency_to_keep = 0
 Keep variants at this total alt allele frequency or higher. More...
 
size_t min_count_to_keep = 0
 
- Public Attributes inherited from vg::Progressive
bool show_progress = false
 

Protected Attributes

MutablePathDeletableHandleGraphgraph
 Holds a reference to the graph we're simplifying. More...
 
VcfBuffervariant_source
 Holds a reference to the variant buffer we are getting avriants from. More...
 

Detailed Description

A class that can be used to simplify a graph, by removing rare variants' alt and ref paths and their exclusively-used nodes.

Constructor & Destructor Documentation

◆ RareVariantSimplifier()

vg::RareVariantSimplifier::RareVariantSimplifier ( MutablePathDeletableHandleGraph graph,
VcfBuffer variant_source 
)

Make a simplifier that simplifies the given graph in place, using variants read using the given buffer.

Member Function Documentation

◆ simplify()

void vg::RareVariantSimplifier::simplify ( )

Simplify the graph.

Member Data Documentation

◆ graph

MutablePathDeletableHandleGraph& vg::RareVariantSimplifier::graph
protected

Holds a reference to the graph we're simplifying.

◆ min_count_to_keep

size_t vg::RareVariantSimplifier::min_count_to_keep = 0

Keep variants with this total alt allele count or higher. AND'd with the frequency condition.

◆ min_frequency_to_keep

double vg::RareVariantSimplifier::min_frequency_to_keep = 0

Keep variants at this total alt allele frequency or higher.

◆ variant_source

VcfBuffer& vg::RareVariantSimplifier::variant_source
protected

Holds a reference to the variant buffer we are getting avriants from.


The documentation for this class was generated from the following files: