<!--# Copyright (C) 2014 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="sm_Tax4Fun" name="Tax4Fun">
    <description> predicts  the  functional or  metabolic capabilities  of  microbial communities  based  on 16S  data  samples</description>
          <command interpreter="perl">sm_Tax4Fun.pl 
        --input $input
        --out $output
        --reference $reference
           </command>
                  <inputs>                  
                        <param format="csv, tabular" name="input" type="data" label="Input filelist containing the OTU table and sample. WARNING : 2 columns only with abundance on the left side and taxonomy on the right side."/>
                        <param name="reference" type="select" label="Folder location of the unzipped reference data">
                               <option value="/galaxydata/galaxy-prod/my_tools/sm_Tax4Fun/SILVA123/">SILVA123</option>
                               <option value="No">OTHER TODO</option>
                          </param> 
                  </inputs>
                  <outputs>
                         <data format="txt" name="output" label ="Tax4Fun result file"/> 
                  </outputs>
  <help>


.. class:: infomark

PLEASE READ THIS MANUAL TO USE TAX4FUN: http://genoweb.toulouse.inra.fr/~formation/GALAXY_news/howto3_Tax4Fun.pdf

.. image:: ${static_path}/images/tax4fun_wf.png


Complete ready-to-use workflow available here : http://genoweb.toulouse.inra.fr/~formation/GALAXY_news/Galaxy-Workflow-Workflow_constructed_from_history__TAX4FUN_.ga

Pipeline:


    This pipeline is used after FROGS pipeline.

    A- First, convert BIOM file result of FROGS in standard BIOM thanks to the following Galaxy tool : « FROGS BIOM to std BIOM Converts a FROGS BIOM in fully compatible BIOM. (Galaxy Version 1.1.0) »
    
    B- Then convert standard BIOM file in TSV file with « FROGS BIOM to TSV Converts a BIOM file in TSV file. (Galaxy Version 2.1.0) » tool.

    C- Select only 2 columns: abundance totale and taxonomy. To recover these data from the previous dataset, you can use « Cut columns from a table (Galaxy Version 1.0.2) » to generate 2 files:  one file with Taxonomy and another with abundance_sum. The tool « Paste two files side by side (Galaxy Version 1.0.0) » paste these 2 files in one (first column: abundance, second column: taxonomy).

    .. image:: ${static_path}/images/tax4fun_inputfile.png

    E- Then « Tax4Fun predicts the functional or metabolic capabilities of microbial communities based on 16S data samples (Galaxy Version 1.0.0) » sort data, rewrite taxonomy, sum abundance for the same taxonomy.  

Warning: The only available reference is SILVA123.


.. class:: infomark


Package Tax4Fun : Prediction of functional profiles from amplicon-data


Description:

     Prediction of functional and metabolic profiles from amplicon-data using the Tax4Fun approach

Usage:

    Tax4Fun(Tax4FunInput, folderReferenceData, fctProfiling = TRUE, refProfile = "UProC", shortReadMode = TRUE, normCopyNo = TRUE)

Arguments:

    Tax4FunInput: (required): list containing the OTU table and sample names, e.g. imported with the functions ‘importQIIMEBiomData’, ‘importQIIMEData’, or ‘importSilvaNgsData’ folderReferenceData: (required): a character vector with one character string indicating the folder location of the unzipped reference data.


Details:

     Tax4Fun predicts the functional and metabolic capabilities of microbial communities based on 16S data samples. Tax4Fun provides a good functional approximation to functional profiles obtained through metagenome sequencing. Tax4Fun can be used as a first instance functional profiling tool for an estimate of the functional capabilities of microbial communities based on amplicon data. Tax4Fun is applicable to output as obtained through the SILVAngs web server or the application of QIIME against the SILVA database.

Value:

     A list containing the predicted functional or metabolic profiles and the FTU statistics


Author(s) Tax4Fun:

     Kathrin P. Asshauer email: kathrin@gobics.de

Author(s) Galaxy Wrapper Tax4Fun:

     Sigenae Team.


References:

      http://gobics.de/kathrin/Tax4Fun/Tax4Fun.html


       
---

Version Galaxy Tool : V1.0.1

---

Contacts : support.sigenae@inra.fr 

    E-learning available : http://genoweb.toulouse.inra.fr/~formation/GALAXY_news/howto3_Tax4Fun.pdf

Please cite :
        
    Depending on the help provided you can cite us in acknowledgements, references or both.
    
    Example of acknowledgements: We wish to thank SIGENAE group and UMR-1280 PhAN Inra-Universite de Nantes.
        
    Example of references : X. SIGENAE [http://www.sigenae.org/]

  </help>
</tool>