annotate sm_Tax4Fun.xml @ 0:4dcbac1c0acf draft

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