annotate frogsfunc_functions.xml @ 9:7bf54edaba24 draft

planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
author oinizan
date Thu, 12 May 2022 10:44:30 +0000
parents
children 613b7551f28b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
1 <?xml version="1.0"?>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
2 <!--
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
3 # Copyright (C) 2022 INRAE
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
4 #
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
5 # This program is free software: you can redistribute it and/or modify
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
6 # it under the terms of the GNU General Public License as published by
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
7 # the Free Software Foundation, either version 3 of the License, or
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
8 # (at your option) any later version.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
9 #
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
10 # This program is distributed in the hope that it will be useful,
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
13 # GNU General Public License for more details.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
14 #
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
15 # You should have received a copy of the GNU General Public License
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
17 -->
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
18 <tool id="FROGSFUNC_step3_functions" name="FROGSFUNC_step3_functions" version= "@TOOL_VERSION@+galaxy@VERSION_SUFFIX@">
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
19 <description>Predicting of functions weighted by the relative abundance of OTUs in the community. Inferring the metagenomes of the communities.</description>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
20
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
21 <macros>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
22 <import>macros.xml</import>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
23 </macros>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
24
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
25 <expand macro="requirements_frogsfunc" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
26
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
27 <stdio>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
28 <exit_code range="1:" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
29 <exit_code range=":-1" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
30 </stdio>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
31 <command >
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
32 frogsfunc_functions.py
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
33 --input-biom $input_biom
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
34 --function $function
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
35 --marker $marker
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
36 --max-nsti $max_nsti
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
37 --function-abund $function_abund
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
38 --seqtab $seqtab
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
39 --weighted $weighted
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
40 --excluded $excluded
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
41 --html $summary_file
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
42 </command>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
43 <inputs>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
44 <!-- Input files -->
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
45 <param argument="--input-biom" format="biom1" name="input_biom" type="data" label="Biom file" help="The abundance file i.e. FROGSFUNC_step1_placeseqs tool output file (frogsfunc_placeseqs.biom)." optional="false"/>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
46 <param argument='--function' format="tabular" type="data" label="Function file" help="Copy number table of functions present in the predicted genome for each OTU i.e. FROGSFUNC_step2_copynumbers tool output file (frogsfunc_copynumbers_predicted_functions.tsv)." optional="false"/>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
47 <param argument='--marker' format="tabular" type="data" label="Marker file" help="Table of predicted marker copy number i.e. FROGSFUNC_step2_copynumbers output (frogsfunc_copynumbers_marker.tsv)." optional="false"/>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
48
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
49 <!-- Parameters-->
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
50 <param argument="--max-nsti" name="max_nsti" type="float" label="NSTI cut-off" help="Any sequence with an NSTI above this threshold will be out. (default: 2)" value="2" min="0" optional="false" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
51 </inputs>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
52 <outputs>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
53 <data format="html" name="summary_file" label="${tool.name}: report.html" from_work_dir="report.html"/>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
54 <data format="tabular" name="seqtab" label="${tool.name}: frogsfunc_functions_marker_norm.tsv" from_work_dir="frogsfunc_functions_marker_norm.tsv.tsv"/>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
55 <data format="tabular" name="weighted" label="${tool.name}: frogsfunc_functions_weighted_nsti.tsv" from_work_dir="frogsfunc_functions_weighted_nsti.tsv"/>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
56 <data format="tabular" name="excluded" label="${tool.name}: frogsfunc_functions_excluded.tsv" from_work_dir="frogsfunc_functions_excluded.tsv"/>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
57 <data format="tabular" name="function_abund" label="${tool.name}: frogsfunc_functions_unstrat.tsv" from_work_dir=" frogsfunc_functions_unstrat.tsv"/>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
58 </outputs>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
59
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
60
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
61 <tests>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
62 <test>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
63 <param name="input_biom" value="references/25-frogsfunc_placeseqs.biom" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
64 <param name="function" value="references/26-frogsfunc_copynumbers_predicted_functions.tsv" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
65 <param name="marker" value="references/26-frogsfunc_copynumbers_marker.tsv"/>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
66 <param name="max_nsti" value="2" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
67 <param name="min_reads" value="1" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
68 <param name="min_samples" value="1" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
69 <param name="strat" value="false" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
70
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
71 <output name="function_abund" file="references/27-frogsfunc_functions_unstrat.tsv" compare="diff" lines_diff="0" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
72 <output name="seqtab" file="references/27-frogsfunc_functions_marker_norm.tsv" compare="diff" lines_diff="0" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
73 <output name="weighted" file="references/27-frogsfunc_functions_weighted_nsti.tsv" compare="diff" lines_diff="0" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
74 <output name="summary_file" file="references/27-frogsfunc_functions_report.html" compare="diff" lines_diff="0" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
75 <output name="excluded" file="references/27-frogsfunc_functions_excluded.txt" compare="diff" lines_diff="0" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
76 </test>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
77 </tests>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
78
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
79 <help>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
80
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
81 @HELP_LOGO@
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
82
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
83 .. class:: infomark page-header h2
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
84
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
85 What it does
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
86
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
87 Predicting of functions weighted by the relative abundance of OTUs in the community. Inferring the metagenomes of the communities with `PICRUSt2 &lt;https://github.com/picrust/picrust2&gt;`_.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
88 There are two steps performed at this stage:
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
89
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
90 (i) The read depth per OTU is divided by the predicted marker (16S/ITS/18S) copy numbers. This is performed to help control for variation in marker copy numbers across organisms, which can result in interpretation issues.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
91 For instance, imagine an organism with five identical copies of the 16S gene that is at the same absolute abundance as an organism with one 16S gene. The OTU corresponding to the first organism would erroneously be inferred to be at higher relative abundance simply because this organism had more copies of the 16S gene.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
92
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
93 (ii) The OTU read depths per sample (after normalizing by marker (16S/ITS/18S) copy number) are multiplied by the predicted function copy numbers per OTU.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
94
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
95
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
96 .. class:: infomark page-header h2
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
97
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
98 Inputs/Outputs
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
99
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
100
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
101 .. class:: h3
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
102
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
103 Inputs
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
104
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
105
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
106 **Biom file**:
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
107
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
108 The OTUs biom file from FROGSFUNC_step1_placeseqs tool (format `biom1 &lt;http://biom-format.org/documentation/format_versions/biom-1.0.html&gt;`_). (frogsfunc_placeseqs.biom)
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
109
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
110 **Function file**:
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
111
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
112 The table of predicted function abundance from FROGSFUNC_step2_copynumbers tool. (frogsfunc_copynumbers_predicted_functions.tsv)
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
113
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
114 **Marker file**:
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
115
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
116 Output table of predicted marker gene copy numbers per sequence from FROGSFUNC_step2_copynumbers tool. (frogsfunc_copynumbers_marker.tsv)
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
117
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
118 **NSTI cut-off**:
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
119
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
120 Nearest Sequenced Taxon Index (`NSTI &lt;https://www.nature.com/articles/nbt.2676&gt;`_) is the phylogenetic distance between the OTU and the nearest sequenced reference genome. This metric can be used to identify OTUs that are highly distant from all reference sequences (the predictions for these sequences are less reliable!). The higher the NSTI score, the less the affiliations are relevant. Any OTUs with a NSTI value higher than 2 are typically either from uncharacterized phyla or off-target sequences.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
121
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
122
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
123 .. class:: h3
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
124
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
125 Outputs
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
126
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
127 **Report file**: (report.html)
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
128
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
129 .. image:: FROGS_frogsfunc_functions_piechart.png
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
130 :height: 500
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
131 :width: 1352
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
132
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
133 OTUs are out if the NSTI associated is above the threshold.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
134
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
135 .. image:: FROGS_frogsfunc_functions_table.png
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
136 :height: 580
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
137 :width: 1352
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
138
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
139
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
140 .. image:: FROGS_frogsfunc_functions_sunburst.png
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
141
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
142
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
143 Gene families/function from KEGG or Metacyc databases are classified according to 3 hierarchy levels. The graph shows the proportion of each level within the selected samples.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
144
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
145 **Function abundance file**:
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
146
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
147 It is the function abundance predictions of metagenome, per sample. (frogsfunc_functions_unstrat.tsv)
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
148
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
149 - Classification column: the hierarchy classification of the gene function.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
150 - db_link column: the url on the link accession ID (*observation_name*) of the function.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
151 - observation_name: Accession identifier
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
152 - last columns: Abundances of these functions in each samples.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
153
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
154 **Excluded sequences**:
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
155
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
156 Information (FROGS taxonomy, PICRUSt2 taxonomy, NSTI) about removed sequences that have a NSTI value aboved the NSTI threshold chosen in this step.
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
157
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
158 **Normalized OTU abundance table**:
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
159
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
160 Table with normalized abundance per marker copy number. (frogsfunc_functions_marker_norm.tsv)
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
161
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
162 **Weighted NSTI file**:
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
163
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
164 It is the table with average NSTI calculated per sample. (frogsfunc_functions_weighted_nsti.tsv)
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
165
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
166
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
167
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
168
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
169 @HELP_CONTACT@
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
170
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
171 </help>
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
172
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
173
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
174 <expand macro="citations" />
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
175
7bf54edaba24 planemo upload for repository https://github.com/geraldinepascal/FROGS-wrappers/ commit 3d595459e82ea1674c83543f41c18169c159450e-dirty
oinizan
parents:
diff changeset
176 </tool>