plot_options.h File Reference

Go to the source code of this file.

Namespaces

 illumina
 
 illumina::interop
 
 illumina::interop::util
 

Functions

std::istream & operator>> (std::istream &in, constants::dna_bases &bases)
 
void add_metric_option (illumina::interop::util::option_parser &description, std::string &metric_name)
 
void add_filter_options (illumina::interop::util::option_parser &description, illumina::interop::model::plot::filter_options &options)
 
std::string plot_image_name (const std::string &plot_name, const std::string &run_name, const std::string &metric_name="", const std::string &extra="")
 

Detailed Description

Option parsing code fo shared plot options

This is a private header file outside of any namespaces, beware!

Date
6/30/16
Version
1.0

Function Documentation

void add_filter_options ( illumina::interop::util::option_parser description,
illumina::interop::model::plot::filter_options options 
)

Add options to parse filter options

This adds the following options to the parser:

  • --filter-by-lane=<lane number>: Only the data for the selected lane will be displayed
  • --filter-by-channel=<channel number>: Only the data for the selected channel will be displayed
  • --filter-by-base=<(A,C,G,T)>: Only the data for the selected base will be displayed
  • --filter-by-surface=<surface number>: Only the data for the selected surface will be displayed
  • --filter-by-read=<read number>: Only the data for the selected read will be displayed
  • --filter-by-cycle=<cycle number>: Only the data for the selected cycle will be displayed
  • --filter-by-lane=<lane number>: Only the data for the selected lane will be displayed
  • --filter-by-tile-number=<tile number>: Only the data for the selected tile number will be displayed
  • --filter-by-swath=<swath number>: Only the data for the selected swath will be displayed
  • --filter-by-section=<section number>: Only the data for the selected section will be displayed
Parameters
descriptionoption parser
optionsvalue to hold filter options
void add_metric_option ( illumina::interop::util::option_parser description,
std::string &  metric_name 
)

Add option to parse metric name

This adds the following options to the parser:

  • --metric-name=<name>: Metric to plot
Parameters
descriptionoption parser
metric_namevalue to hold metric name
std::string plot_image_name ( const std::string &  plot_name,
const std::string &  run_name,
const std::string &  metric_name = "",
const std::string &  extra = "" 
)

Create a default image file name

Parameters
plot_namename of the plot
run_namename of the run folder
metric_nameoptional metric name
extraextra info
Returns
plot image filename