generate_graph.html 2.88 KB
Newer Older
Matthieu Muffato's avatar
Matthieu Muffato committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>generate_graph.pl</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>

<body style="background-color: white">



<h1 id="NAME">NAME</h1>

<pre><code>    generate_graph.pl</code></pre>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

20
<pre><code>    ./generate_graph.pl [ -url mysql://user:pass@server:port/dbname ] [-pipeconfig TopUp_conf.pm]* -output OUTPUT_LOC [-help]</code></pre>
Matthieu Muffato's avatar
Matthieu Muffato committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<pre><code>    This program will generate a graphical representation of your hive pipeline.
    This includes visalising the flow of data from the different analyses, blocking
    rules &amp; table writers. The graph is also coloured to indicate the stage
    an analysis is at. The colours &amp; fonts used can be configured via
    hive_config.json configuration file.</code></pre>

<h1 id="OPTIONS">OPTIONS</h1>

<p><b>--url</b></p>

<pre><code>    url defining where hive database is located</code></pre>

<p><b>--reg_conf</b></p>

<pre><code>    path to a Registry configuration file</code></pre>

<p><b>--reg_alias</b></p>

<pre><code>    species/alias name for the Hive DBAdaptor</code></pre>

44 45 46 47 48
<p><b>--pipeconfig</b></p>

<pre><code>    A pipeline configuration file that can function both as the initial source of pipeline structure or as a top-up config.
    This option can now be used multiple times for multiple top-ups.</code></pre>

Matthieu Muffato's avatar
Matthieu Muffato committed
49 50 51 52 53 54 55 56 57 58 59
<p><b>--output</b></p>

<pre><code>    Location of the file to write to.
    The file extension (.png , .jpeg , .dot , .gif , .ps) will define the output format.</code></pre>

<h1 id="EXTERNAL-DEPENDENCIES">EXTERNAL DEPENDENCIES</h1>

<pre><code>    GraphViz</code></pre>

<h1 id="LICENSE">LICENSE</h1>

60 61
<pre><code>    Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
<pre><code>    Copyright [2016] EMBL-European Bioinformatics Institute
Matthieu Muffato's avatar
Matthieu Muffato committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81

    Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

         http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License
    is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and limitations under the License.</code></pre>

<h1 id="CONTACT">CONTACT</h1>

<pre><code>    Please subscribe to the Hive mailing list:  http://listserver.ebi.ac.uk/mailman/listinfo/ehive-users  to discuss Hive-related questions or to be notified of our updates</code></pre>


</body>

</html>