Commit f7249872 authored by Jerome Mariette's avatar Jerome Mariette

No commit message

No commit message
parent b0c6bbdb
......@@ -82,6 +82,7 @@
</ul>
</li>
<li><a href="#process">Process</a></li>
<li><a href="#get_resource">Get Resource</a></li>
</ul>
</nav>
......@@ -702,11 +703,12 @@ class MyWorkflow (NG6Workflow):
<h3>add_input_directory()</h3>
<p>
The add input directory allow the user to select a list of files inside a specific directory.
The parameter <code>get_files_fn</code> specify a function that can be used to retrieve a list of files inside the specified
folder. This method can have as many arguments as it should, but must have as first argument a string which represents the path of the parsed folder.
By default all files will be selected. To retrieve the list of files inside the directory, use the method <code>get_files()</code>
from the created parameter object.
The <code>add_input_directory()</code> method allows the user to select files from a specific directory. This
kind of input can be useful for tools outputing not only files but an organized directory.
The parameter <code>get_files_fn</code> specify the function that will be used to retrieve the files. This method can
take as many arguments as required, but the first argument has to be a string representing the folder path.
By default all files will be selected. From the workflow <code>process()</code> function, the files can be retrieved
by using the <code>get_files()</code> method.
</p>
<h4>Example</h4>
......@@ -1052,6 +1054,37 @@ bwamem = self.add_component("BWAmem", [bwaindex.databank, self.reads])</code></p
</div>
</section>
<section id="get_resource" class="group">
<h1 class="page-header">Get shared resources</h1>
<p>The method <code>get_resource()</code>, giving a specific resource, returns the defined value within the <code>resource</code>
section of the jflow configuration file.</p>
<h3>Options</h3>
<p>There is one required argument : resource.</p>
<div class="table-responsive">
<table class="table table-bordered table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>resource</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The resource name for which is requested the configured value.</td>
</tr>
</tbody>
</table>
</div>
</div>
</section>
</div>
</div>
......
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