annotate obiclean.xml @ 4:c210936fafe0 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
author iuc
date Wed, 01 Sep 2021 07:53:04 +0000
parents d13f3cc6cd60
children c78f86dd30c1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
1 <tool id="obi_clean" name="obiclean" version="@TOOL_VERSION@" profile="@PROFILE@">
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
2 <description>tags a set of sequences for PCR/sequencing errors identification</description>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
3 <expand macro="bio_tools"/>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
4 <macros>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
5 <import>macros.xml</import>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
6 </macros>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
7 <expand macro="requirements"/>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
8 <expand macro="stdio"/>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
9
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
10 <command><![CDATA[
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
11 @GUNZIP_INPUT@
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
12 obiclean
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
13 --without-progress-bar
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
14 #if $distance
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
15 -d '$distance'
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
16 #end if
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
17 #if $key
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
18 -s '$key'
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
19 #end if
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
20 #if $ratio
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
21 -r '$ratio'
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
22 #end if
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
23 ${head}
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
24 @INPUT_FORMAT@
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
25 @OUT_FORMAT@
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
26 input
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
27 @GZIP_OUTPUT@
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
28 >'$output'
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
29 @GENERATE_GALAXY_JSON@
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
30 ]]></command>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
31 <inputs>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
32 <param name="input" type="data" format="@INPUT_FORMATS@" label="Input sequences file" />
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
33 <param name="distance" type="integer" value="1" optional="true" label="Maximum numbers of differences between two variant sequences (default: 1)" />
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
34 <param name="key" type="text" optional="true" label="Specify an attribute containing sample definition" />
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
35 <param name="ratio" optional="true" type="float" value="1" label="Threshold ratio between counts (rare/abundant counts) of two sequence records so that the less abundant one is a variant of the more abundant (default: 1, i.e. all less abundant sequences are variants)" />
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
36 <param name="head" type="boolean" checked="false" truevalue="-H" falsevalue="" label="Do you want to select only sequences with the head status in a least one sample?" />
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
37 <expand macro="input_format_options_macro"/>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
38 <expand macro="out_format_macro"/>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
39 </inputs>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
40 <outputs>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
41 <data format="auto" name="output"/>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
42 </outputs>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
43 <tests>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
44 <test>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
45 <param name="input" value="output_obiannotate.fasta" />
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
46 <param name="head" value="True"/>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
47 <output name="output" file="output_obiclean_simple.fasta" ftype="fasta"/>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
48 </test>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
49 <test>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
50 <param name="input" value="output_obiannotate.fasta.gz" />
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
51 <param name="key" value="merged_sample"/>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
52 <param name="ratio" value="0.05"/>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
53 <param name="head" value="False"/>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
54 <output name="output" file="output_obiclean_advanced.fasta.gz" ftype="fasta.gz" decompress="true"/>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
55 </test>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
56 </tests>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
57 <help><![CDATA[
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
58
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
59 .. class:: infomark
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
60
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
61 **What it does**
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
62
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
63 obijoinpairedend aims at joining the two reads of a paired-end library.
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
64
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
65 For this purpose, it concatenates sequence merging the forward read and the reversed-complemented reverse read.
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
66
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
67 The program uses as input one or two sequences reads files.
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
68
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
69 If two files are used one of them must be specified using the -r option. Sequence records corresponding to the same read pair must be in the same order in the two files.
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
70 If just one file is provided, sequence records are supposed to be all of the same length. The first half of the sequence is used as forward read, the second half is used as the reverse read.
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
71
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
72 @OBITOOLS_LINK@
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
73
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
74 ]]>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
75 </help>
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
76 <expand macro="citation" />
c210936fafe0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 3
diff changeset
77 </tool>