ensembl-hive  2.1
 All Classes Namespaces Files Functions Pages
Bio::EnsEMBL::Hive::Utils::Graph Class Reference
+ Inheritance diagram for Bio::EnsEMBL::Hive::Utils::Graph:
+ Collaboration diagram for Bio::EnsEMBL::Hive::Utils::Graph:

Public Member Functions

public Graph new ()
 
public GraphViz graph ()
 
public DBAdaptor hive_dba ()
 
protected _analysis_node_name ()
 
protected _table_node_name ()
 
protected _midpoint_name ()
 
public The build ()
 
protected _propagate_allocation ()
 
protected _add_pipeline_label ()
 
protected _add_analysis_node ()
 
protected _add_control_rules ()
 
protected _add_dataflow_rules ()
 
protected _add_table_node ()
 
- Public Member Functions inherited from Bio::EnsEMBL::Hive::Configurable
public config ()
 
public context ()
 
public config_get ()
 
public config_set ()
 

Detailed Description

Synopsis

my $hive_dba = get_hive_dba();
my $g = Bio::EnsEMBL::Hive::Utils::Graph->new(-DBA => $hive_dba);
my $graphviz = $g->build();
$graphviz->as_png('location.png');

Description

    This is a module for converting a hive database's flow of analyses, control 
    rules and dataflows into the GraphViz model language. This information can
    then be converted to an image or to the dot language for further manipulation
    in GraphViz.

Member Function Documentation

protected Bio::EnsEMBL::Hive::Utils::Graph::_add_analysis_node ( )

Undocumented method

Code:
click to view
protected Bio::EnsEMBL::Hive::Utils::Graph::_add_control_rules ( )

Undocumented method

Code:
click to view
protected Bio::EnsEMBL::Hive::Utils::Graph::_add_dataflow_rules ( )

Undocumented method

Code:
click to view
protected Bio::EnsEMBL::Hive::Utils::Graph::_add_pipeline_label ( )

Undocumented method

Code:
click to view
protected Bio::EnsEMBL::Hive::Utils::Graph::_add_table_node ( )

Undocumented method

Code:
click to view
protected Bio::EnsEMBL::Hive::Utils::Graph::_analysis_node_name ( )

Undocumented method

Code:
click to view
protected Bio::EnsEMBL::Hive::Utils::Graph::_midpoint_name ( )

Undocumented method

Code:
click to view
protected Bio::EnsEMBL::Hive::Utils::Graph::_propagate_allocation ( )

Undocumented method

Code:
click to view
protected Bio::EnsEMBL::Hive::Utils::Graph::_table_node_name ( )

Undocumented method

Code:
click to view
public The Bio::EnsEMBL::Hive::Utils::Graph::build ( )
  Returntype : The GraphViz object built & populated
  Exceptions : Raised if there are issues with accessing the database
  Description : Builds the graph object and returns it.
  Status     : Beta
 
Code:
click to view
public GraphViz Bio::EnsEMBL::Hive::Utils::Graph::graph ( )
  Arg [1] : The GraphViz instance created by this module
  Returntype : GraphViz
  Exceptions : None
  Status     : Beta
 
Code:
click to view
public DBAdaptor Bio::EnsEMBL::Hive::Utils::Graph::hive_dba ( )
  Arg [1] : The DBAdaptor instance
  Returntype : DBAdaptor
  Exceptions : If the given object is not a hive DBAdaptor
  Status     : Beta
 
Code:
click to view
public Graph Bio::EnsEMBL::Hive::Utils::Graph::new ( )
  Arg [1] : Bio::EnsEMBL::Hive::DBSQL::DBAdaptor $hive_dba;
              The adaptor to get information from
  Arg [2] : (optional) string $config_file_name;
                  A JSON file name to initialize the Config object with.
                  If one is not given then we don't pass anything into Config's constructor,
                  which results in loading configuration from Config's standard locations.
  Returntype : Graph object
  Exceptions : If the parameters are not as required
  Status     : Beta
 
Code:
click to view

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