annotate sm_Tax4Fun.xml @ 5:f8c679b63816 draft

New xml version
author sarahinraauzeville
date Thu, 21 Dec 2017 06:06:11 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
1 <!--# Copyright (C) 2014 INRA
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
2 # This program is free software: you can redistribute it and/or modify
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
3 # it under the terms of the GNU General Public License as published by
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
4 # the Free Software Foundation, either version 3 of the License, or
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
5 # (at your option) any later version.
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
6 #
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
7 # This program is distributed in the hope that it will be useful,
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
8 # but WITHOUT ANY WARRANTY; without even the implied warranty of
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
9 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
10 # GNU General Public License for more details.
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
11 #
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
12 # You should have received a copy of the GNU General Public License
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
13 # along with this program. If not, see http://www.gnu.org/licenses/.
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
14 #-->
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
15 <tool id="sm_Tax4Fun" name="Tax4Fun">
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
16 <description> predicts the functional or metabolic capabilities of microbial communities based on 16S data samples</description>
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
17 <command interpreter="perl">sm_Tax4Fun.pl
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
18 --input $input
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
19 --out $output
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
20 --reference $reference
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
21 </command>
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
22 <inputs>
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
23 <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."/>
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
24 <param name="reference" type="select" label="Folder location of the unzipped reference data">
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
25 <option value="/galaxydata/galaxy-prod/my_tools/sm_Tax4Fun/SILVA123/">SILVA123</option>
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
26 <option value="No">OTHER TODO</option>
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
27 </param>
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
28 </inputs>
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
29 <outputs>
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
30 <data format="txt" name="output" label ="Tax4Fun result file"/>
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
31 </outputs>
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
32 <help>
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
33
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
34
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
35 .. class:: infomark
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
36
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
37 PLEASE READ THIS MANUAL TO USE TAX4FUN: http://genoweb.toulouse.inra.fr/~formation/GALAXY_news/howto3_Tax4Fun.pdf
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
38
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
39 .. image:: ${static_path}/images/tax4fun_wf.png
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
40
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
41
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
42 Complete ready-to-use workflow available here : http://genoweb.toulouse.inra.fr/~formation/GALAXY_news/Galaxy-Workflow-Workflow_constructed_from_history__TAX4FUN_.ga
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
43
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
44 Pipeline:
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
45
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
46
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
47 This pipeline is used after FROGS pipeline.
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
48
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
49 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) »
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
50
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
51 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.
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
52
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
53 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).
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
54
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
55 .. image:: ${static_path}/images/tax4fun_inputfile.png
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
56
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
57 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.
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
58
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
59 Warning: The only available reference is SILVA123.
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
60
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
61
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
62 .. class:: infomark
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
63
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
64
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
65 Package Tax4Fun : Prediction of functional profiles from amplicon-data
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
66
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
67
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
68 Description:
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
69
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
70 Prediction of functional and metabolic profiles from amplicon-data using the Tax4Fun approach
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
71
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
72 Usage:
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
73
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
74 Tax4Fun(Tax4FunInput, folderReferenceData, fctProfiling = TRUE, refProfile = "UProC", shortReadMode = TRUE, normCopyNo = TRUE)
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
75
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
76 Arguments:
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
77
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
78 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.
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
79
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
80
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
81 Details:
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
82
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
83 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.
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
84
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
85 Value:
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
86
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
87 A list containing the predicted functional or metabolic profiles and the FTU statistics
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
88
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
89
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
90 Author(s) Tax4Fun:
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
91
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
92 Kathrin P. Asshauer email: kathrin@gobics.de
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
93
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
94 Author(s) Galaxy Wrapper Tax4Fun:
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
95
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
96 Sigenae Team.
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
97
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
98
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
99 References:
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
100
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
101 http://gobics.de/kathrin/Tax4Fun/Tax4Fun.html
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
102
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
103
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
104
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
105 ---
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
106
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
107 Version Galaxy Tool : V1.0.1
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
108
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
109 ---
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
110
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
111 Contacts : support.sigenae@inra.fr
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
112
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
113 E-learning available : http://genoweb.toulouse.inra.fr/~formation/GALAXY_news/howto3_Tax4Fun.pdf
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
114
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
115 Please cite :
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
116
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
117 Depending on the help provided you can cite us in acknowledgements, references or both.
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
118
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
119 Example of acknowledgements: We wish to thank SIGENAE group and UMR-1280 PhAN Inra-Universite de Nantes.
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
120
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
121 Example of references : X. SIGENAE [http://www.sigenae.org/]
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
122
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
123 </help>
f8c679b63816 New xml version
sarahinraauzeville
parents:
diff changeset
124 </tool>