annotate biom_to_stdBiom.xml @ 0:59bc96331073 draft default tip

planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/tree/v3.1.0 commit 08296fc88e3e938c482c631bd515b3b7a0499647

<?xml version="1.0"?>
<!--
# Copyright (C) 2015 INRA
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-->
<tool id="FROGS_biom_to_stdBiom" name="FROGS BIOM to std BIOM" version="3.1">
	<description>Converts a FROGS BIOM in fully compatible BIOM.</description>
        <requirements>
                <requirement type="package" version="3.1.0">frogs</requirement>
        </requirements>
        <stdio>
                <exit_code range="1:" />
                <exit_code range=":-1" />
        </stdio>
	<command>
		biom_to_stdBiom.py 
		                --input-biom $input_biom
		                --output-biom $output_biom
		                --output-metadata $output_blast_details
	</command>
	<inputs>
		<!-- Files -->
		<param format="biom1" name="input_biom" type="data" label="Abundance file" help="The FROGS BIOM file to convert (format: BIOM)." optional="false" />
	</inputs>
	<outputs>
		<data format="biom1" name="output_biom" label="${tool.name}: abundance.biom" from_work_dir="abundance.biom"/>
		<data format="tabular" name="output_blast_details" label="${tool.name}: blast_details.tsv" from_work_dir="blast_details.tsv" />
	</outputs>
	<tests>
		<test>
			<param name="input_biom" value="references/06-affiliation.biom"/>
			<output name="output_biom" value="references/11-affiliation_std.biom"/>
			<output name="output_blast_details" value="references/11-affiliation_multihit.tsv"/>
		</test>
	</tests>
	<help>

.. image:: static/images/frogs_images/FROGS_logo.png
   :height: 144
   :width: 110


.. class:: infomark page-header h2

What it does

Converts a BIOM generated by FROGS in generic BIOM.

The detailed blast affiliations can trigger problem with tools like Qiime. This tool extracts the blast details in a second file and writes a BIOM usable in every tools using BIOM.

.. class:: h3

Inputs

**Abundance file**:
 
The abundance of each cluster in each sample (format `BIOM &lt;http://biom-format.org/&gt;`_).

.. class:: h3

Outputs

**Abundance file**:

 The abundance without the ambiguous blast details (format `BIOM &lt;http://biom-format.org/&gt;`_).

**Blast details file**:

 The details for each alignment on clusters (format `TSV &lt;https://en.wikipedia.org/wiki/Tab-separated_values&gt;`_).


.. class:: infomark page-header h2

How it works

FROGS BIOM to std BIOM extracts the blast alignment details in a second file, write a BIOM usable in every tools using BIOM and defined the consensus taxonomy provided by blast as main taxonomy.



----

**Contact**

Contacts: [e-mail]

Repository: https://github.com/geraldinepascal/FROGS
website: http://frogs.toulouse.inra.fr/

Please cite the **FROGS article**: *Escudie F., et al. Bioinformatics, 2018. FROGS: Find, Rapidly, OTUs with Galaxy Solution.*

	</help>
	<citations>
		<citation type="doi">10.1093/bioinformatics/btx791</citation>
	</citations>

</tool>