RAPPEL : Opération de maintenance > ForgeMIA indisponible le 20 Janvier entre 7h et 12h

Commit e3221d3a authored by Ibouniyamine Nabihoudine's avatar Ibouniyamine Nabihoudine
Browse files

No commit message

No commit message
parent 7bbcdd80
......@@ -119,7 +119,7 @@
<ul>
<li>implement a class inheriting from the <code>Workflow</code> class,</li>
<li>overload the <code>get_description()</code> method to provide the final user a description of the workflow,</li>
<li>overload the <code>get_description()</code> method to provide to the final user a description of the workflow,</li>
<li>overload the <code>define_parameters()</code> method to add the workflow inputs and parameters,</li>
<li>overload the <code>process()</code> method by adding components and setting their arguments,</li>
<li>link the components inputs and outputs.</li>
......@@ -146,7 +146,7 @@ class MyWorkflow (Workflow):
<h1 class="page-header">Define parameters</h1>
<p>
The <code>define_parameters()</code> method is used to add workflow parameters, inputs and outputs. To do so, several methods are available.
Once defined, the new parameters, are available as object attibuts, thus they are accessible through <code>self.parameter_name</code>.
Once defined, the new parameters are available as object attibuts, thus they are accessible through <code>self.parameter_name</code>.
</p>
<p>
Several types of parameters can be added, all described in the following sections. All have two required positional
......@@ -196,7 +196,7 @@ class MyWorkflow (Workflow):
<tbody>
<tr>
<td>name</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The name of the parameter. The parameter value is accessible
......@@ -205,7 +205,7 @@ class MyWorkflow (Workflow):
<tr>
<td>help</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The parameter help message.</td>
......@@ -216,12 +216,12 @@ class MyWorkflow (Workflow):
<td>-</td>
<td>false</td>
<td>None</td>
<td>The default parameter value. It's type is depending on the parameter type.</td>
<td>The default parameter value. It's type depends on the parameter type.</td>
</tr>
<tr>
<td>type</td>
<td>str</td>
<td>string</td>
<td>false</td>
<td>"str"</td>
<td>The parameter type. The value provided by the final user will be casted and checked against this type.
......@@ -295,7 +295,7 @@ class MyWorkflow (Workflow):
<h2>Inputs</h2>
<p>Just like for parameters, inputs can be added to handle a single file or a list of files. Thus, the <code>add__input_file()</code> method can be used to force
the final user to provide one and only one file, where the <code>add__input_file_list()</code> method allows the final user to give as many files he
the final user to provide one and only one file, where the <code>add__input_file_list()</code> method allows the final user to give as many files as he
wants.</p>
<h3>add_input_file()</h3>
......@@ -330,7 +330,7 @@ class MyWorkflow (Workflow):
<tbody>
<tr>
<td>name</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The name of the parameter. The parameter value is accessible
......@@ -339,7 +339,7 @@ class MyWorkflow (Workflow):
<tr>
<td>help</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The parameter help message.</td>
......@@ -475,15 +475,15 @@ self.add_parameter("sequencer", "The sequencer type.", choices=["HiSeq2000",
<tbody>
<tr>
<td>name</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The name of the parameter</td>
<td>The name of the parameter.</td>
</tr>
<tr>
<td>help</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The help message pronpted to the user.</td>
......@@ -552,7 +552,7 @@ self.add_parameter("sequencer", "The sequencer type.", choices=["HiSeq2000",
<tbody>
<tr>
<td>*args2exclude</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The name of the parameter to exclude.</td>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment