Mercurial > repos > frogs > frogs_2_0_0

annotate clustering.xml @ 0:76c750c5f0d1 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
author frogs
date Thu, 25 Oct 2018 05:01:13 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
1 <?xml version="1.0"?>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
2 <!--
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
3 # Copyright (C) 2015 INRA
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
4 #
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
5 # This program is free software: you can redistribute it and/or modify
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
6 # it under the terms of the GNU General Public License as published by
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
7 # the Free Software Foundation, either version 3 of the License, or
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
8 # (at your option) any later version.
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
9 #
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
10 # This program is distributed in the hope that it will be useful,
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
13 # GNU General Public License for more details.
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
14 #
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
15 # You should have received a copy of the GNU General Public License
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
17 -->
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
18 <tool id="FROGS_clustering" name="FROGS Clustering swarm" version="2.3.0">
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
19 <description>Step 2 in metagenomics analysis : clustering.</description>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
20 <requirements>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
21 <requirement type="package" version="2.0.1">frogs</requirement>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
22 </requirements>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
23 <stdio>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
24 <exit_code range="1:" />
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
25 <exit_code range=":-1" />
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
26 </stdio>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
27 <command>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
28 clustering.py
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
29 --nb-cpus $nb_cpus
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
30 --distance $maximal_distance
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
31 --input-fasta $sequence_file
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
32 --input-count $count_file
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
33 --output-biom $abundance_biom
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
34 --output-fasta $seed_file
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
35 --output-compo $swarms_composition
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
36 $denoising
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
37 </command>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
38 <inputs>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
39 <!-- Files -->
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
40 <param format="fasta" name="sequence_file" type="data" label="Sequences file" help="The sequences file (format: fasta)." optional="false" />
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
41 <param format="tabular" name="count_file" type="data" label="Count file" help="It contains the count by sample for each sequence (format: TSV)." optional="false" />
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
42 <!-- Parameters -->
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
43 <param name="nb_cpus" type="hidden" label="CPU number" help="The maximum number of CPUs used." value="1" />
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
44 <param name="maximal_distance" type="integer" label="Aggregation distance" help="Maximum number of differences between sequences in each aggregation step." value="3" min="1" max="15" optional="false" />
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
45 <param name="denoising" type="boolean" checked="true" truevalue="--denoising" falsevalue="" label="Performe denoising clustering step?" help="If checked, clustering will be perform in two steps, first with distance = 1 and then with your input distance"/>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
46 </inputs>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
47 <outputs>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
48 <data format="fasta" name="seed_file" label="${tool.name}: seed_sequences.fasta" from_work_dir="seeds.fasta"/>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
49 <data format="biom1" name="abundance_biom" label="${tool.name}: abundance.biom" from_work_dir="abundance.biom" />
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
50 <data format="tabular" name="swarms_composition" label="${tool.name}: swarms_composition.tsv" from_work_dir="swarms.tsv"/>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
51 </outputs>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
52 <tests>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
53 <test>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
54 <param name="sequence_file" value="references/01-prepro.fasta"/>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
55 <param name="count_file" value="references/01-prepro.tsv"/>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
56 <param name="maximal_distance" value="3"/>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
57 <param name="denoising" value="true"/>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
58 <output name="seed_file" file="references/02-clustering.fasta" compare="sim_size" delta="0" />
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
59 <!-- output name="abundance_biom" file="references/02-clustering.biom" -->
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
60 <!-- Voila deux autres facon de comparer: (Mais ca ne marche pas dans ce cas car les fichiers générés par planemo sont vraiments différents comparé à nos test manuels (cf. /tmp/frogs-test-result-olivier /tmp/frogs-test-result-olivier2) -->
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
61 <!-- cf. https://docs.galaxyproject.org/en/latest/dev/schema.html#tool-tests-test-output -->
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
62 <!--output name="abundance_biom" file="references/02-clustering.biom" compare="sim_size" delta="10"/-->
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
63 <!--output name="abundance_biom" file="references/02-clustering.biom" compare="diff" lines_diff="1"/-->
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
64 <output name="swarms_composition" file="references/02-clustering_compo.tsv" compare="sim_size" delta="0" />
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
65 </test>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
66 </tests>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
67 <help>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
68
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
69 .. image:: static/images/FROGS_logo.png
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
70 :height: 144
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
71 :width: 110
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
72
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
73
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
74 .. class:: infomark page-header h2
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
75
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
76 What it does
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
77
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
78 Single-linkage clustering on sequences.
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
79
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
80
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
81 .. class:: infomark page-header h2
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
82
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
83 Inputs/Outputs
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
84
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
85 .. class:: h3
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
86
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
87 Inputs
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
88
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
89 **Sequences file**:
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
90
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
91 The sequence file with all samples sequences (format `FASTA &lt;https://en.wikipedia.org/wiki/FASTA_format&gt;`_). These sequences are dereplicated: strictly identical sequence are represented only one and the initial count is kept in count file.
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
92
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
93 The sequence ID must be "sequenceID;size=X" with X equal to the total abundance among all samples.
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
94
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
95 *It corresponds to one output of FROGS Pre-process tools.*
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
96
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
97 **Count file**:
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
98
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
99 This file contains the count of all uniq sequences in each sample (format `TSV &lt;https://en.wikipedia.org/wiki/Tab-separated_values&gt;`_).
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
100
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
101 Example::
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
102
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
103 #id splA splB
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
104 seq1 1289 2901
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
105 seq2 3415 0
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
106
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
107
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
108 .. class:: h3
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
109
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
110 Outputs
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
111
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
112 **Abundance file** (abundance.biom):
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
113
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
114 The abundance of each cluster in each sample (format `BIOM &lt;http://biom-format.org/&gt;`_). This format is widely used in metagenomic softwares.
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
115
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
116
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
117 **Clusters seeds** (seed_sequences.fasta):
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
118
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
119 The clusters representative sequences (format `FASTA &lt;https://en.wikipedia.org/wiki/FASTA_format&gt;`_).
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
120
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
121
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
122 **Clusters composition** (swarms_composition.tsv):
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
123
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
124 A text file representing the read composition of each cluster (format txt). Each line represents one cluster and is composed of read identifier separated by space.
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
125
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
126
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
127 .. class:: infomark page-header h2
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
128
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
129 How it works
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
130
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
131 .. csv-table::
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
132 :header: "Steps", "With denoising", "Without denoising"
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
133 :widths: 5, 150, 150
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
134 :class: table table-striped
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
135
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
136 "1", "Sorting the reads by their abundance", "Sorting the reads by their abundance"
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
137 "2", "Clusters the reads (`Swarm &lt;https://github.com/torognes/swarm&gt;`_). The distance parameter is 1", "/"
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
138 "3", "Sorting the pre-clusters by their abundance", "/"
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
139 "4", "Clusters the pre-clusters (`Swarm &lt;https://github.com/torognes/swarm&gt;`_) with the distance you specify", "Clusters the reads (`Swarm &lt;https://github.com/torognes/swarm&gt;`_) with the distance you specify"
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
140
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
141 **Swarm focus**
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
142
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
143 Swarm use an iterative growth process and the use of sequence abundance values to delineate OTUs.
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
144
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
145 .. image:: static/images/FROGS_cluster_swarm.png
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
146 :height: 223
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
147 :width: 666
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
148
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
149 In each groth step the sequence of the previous step is used to find the others sequences with a number of differences inferior or equal to the "Aggregation distance".
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
150
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
151 After agregation Swarm refines the clusters by looking at the abundancies along the connections. Theoritically the abundances must decrease when you are going away from the seed (which is often the most abundant sequence). If this abundance raises again it means that two different clusters are connected by some poorly abundant sequences, so swarm cut the connection.
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
152
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
153
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
154 .. class:: infomark page-header h2
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
155
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
156 Advices
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
157
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
158 The denoising step allows to build very fine clusters with minimal differences. In this case, the number of differences is equal at 1 between sequences of each crowns. This first clustering is extremly quick. After the denoising, a second swarm is run with an aggregation distance >1 as you have configured, between seeds from this first clustering.
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
159
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
160 To have some metrics on your clusters, you can use the tool **FROGS Clusters Stat**.
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
161
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
162
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
163 ----
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
164
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
165 **Contact**
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
166
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
167 Contacts: frogs@inra.fr
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
168
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
169 Repository: https://github.com/geraldinepascal/FROGS
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
170
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
171 Please cite the FROGS Publication: *Escudie F., Auer L., Bernard M., Cauquil L., Vidal K., Maman S., Mariadassou M., Hernadez-Raquet G., Pascal G., 2015. FROGS: Find Rapidly OTU with Galaxy Solution. In: The environmental genomic Conference, Montpellier, France,* http://bioinfo.genotoul.fr/fileadmin/user_upload/FROGS_2015_GE_Montpellier_poster.pdf
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
172
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
173 Depending on the help provided you can cite us in acknowledgements, references or both.
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
174 </help>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
175 <citations>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
176 <citation type="doi">10.7287/peerj.preprints.386v1</citation>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
177 </citations>
76c750c5f0d1 planemo upload for repository https://github.com/oinizan/FROGS-wrappers commit 0b900a51e220ce6f17c1e76292c06a5f4d934055-dirty
frogs
parents:
diff changeset
178 </tool>