Sign upLogin

Ensembl/ensembl-hive

View on GitHub
Star
docs/scripts/seed_pipeline.html

Summary

Maintainability
Test Coverage
<?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>seed_pipeline.pl</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>

<body>



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

<pre><code>    seed_pipeline.pl</code></pre>

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

<pre><code>    seed_pipeline.pl {-url &lt;url&gt; | -reg_conf &lt;reg_conf&gt; [-reg_type &lt;reg_type&gt;] -reg_alias &lt;reg_alias&gt;} [ {-analyses_pattern &lt;pattern&gt; | -analysis_id &lt;analysis_id&gt; | -logic_name &lt;logic_name&gt;} [ -input_id &lt;input_id&gt; ] ]</code></pre>

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

<pre><code>    seed_pipeline.pl is a generic script that is used to create {initial or top-up} jobs for hive pipelines</code></pre>

<h1 id="USAGE-EXAMPLES">USAGE EXAMPLES</h1>

<pre><code>        # find out which analyses may need seeding (with an example input_id):

    seed_pipeline.pl -url &quot;mysql://ensadmin:${ENSADMIN_PSW}@localhost:3306/lg4_long_mult&quot;


        # seed one job into the &quot;start&quot; analysis:

    seed_pipeline.pl -url &quot;mysql://ensadmin:${ENSADMIN_PSW}@localhost:3306/lg4_long_mult&quot; \
                     -logic_name start -input_id &#39;{&quot;a_multiplier&quot; =&gt; 2222222222, &quot;b_multiplier&quot; =&gt; 3434343434}&#39;</code></pre>

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

<h2 id="Connection-parameters">Connection parameters</h2>

<pre><code>    -reg_conf &lt;path&gt;            : path to a Registry configuration file
    -reg_type &lt;string&gt;          : type of the registry entry (&#39;hive&#39;, &#39;core&#39;, &#39;compara&#39;, etc - defaults to &#39;hive&#39;)
    -reg_alias &lt;string&gt;         : species/alias name for the Hive DBAdaptor
    -url &lt;url string&gt;           : url defining where hive database is located
    -nosqlvc &lt;0|1&gt;              : skip sql version check if 1</code></pre>

<h2 id="Analysis-parameters">Analysis parameters</h2>

<pre><code>    -analyses_pattern &lt;string&gt;  : seed job(s) for analyses whose logic_name matches the supplied pattern
    -analysis_id &lt;num&gt;          : seed job for analysis with the given analysis_id</code></pre>

<h2 id="Input">Input</h2>

<pre><code>    -input_id &lt;string&gt;          : specify the input_id as a stringified hash </code></pre>

<h2 id="Other-commands-options">Other commands/options</h2>

<pre><code>    -h | -help                  : show this help message</code></pre>

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

<pre><code>    Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
    Copyright [2016-2021] EMBL-European Bioinformatics Institute

    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>