annotate obiclean.xml @ 4:08d873cdd5f6 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
author iuc
date Wed, 20 Mar 2024 13:17:36 +0000
parents 12baadec7809
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
1 <tool id="obi_clean" name="obiclean" version="@TOOL_VERSION@" profile="@PROFILE@">
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
2 <description>tags a set of sequences for PCR/sequencing errors identification</description>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
3 <macros>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
4 <import>macros.xml</import>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
5 </macros>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
6 <expand macro="bio_tools"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
7 <expand macro="requirements"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
8 <expand macro="stdio"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
9
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
10 <command><![CDATA[
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
11 @GUNZIP_INPUT@
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
12 obiclean
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
13 --without-progress-bar
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
14 #if $distance
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
15 -d '$distance'
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
16 #end if
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
17 #if $key
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
18 -s '$key'
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
19 #end if
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
20 #if $ratio
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
21 -r '$ratio'
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
22 #end if
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
23 ${head}
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
24 @INPUT_FORMAT@
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
25 @OUT_FORMAT@
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
26 input
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
27 @GZIP_OUTPUT@
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
28 >'$output'
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
29 @GENERATE_GALAXY_JSON@
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
30 ]]></command>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
31 <inputs>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
32 <param name="input" type="data" format="@INPUT_FORMATS@" label="Input sequences file"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
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)"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
34 <param name="key" type="text" optional="true" label="Specify an attribute containing sample definition"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
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)"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
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?"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
37 <expand macro="input_format_options_macro"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
38 <expand macro="out_format_macro"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
39 </inputs>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
40 <outputs>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
41 <data format="auto" name="output"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
42 </outputs>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
43 <tests>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
44 <test expect_num_outputs="1">
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
45 <param name="input" value="output_obiannotate.fasta" />
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
46 <param name="head" value="True"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
47 <output name="output" file="output_obiclean_simple.fasta" ftype="fasta"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
48 </test>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
49 <test expect_num_outputs="1">
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
50 <param name="input" value="output_obiannotate.fasta.gz" />
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
51 <param name="key" value="merged_sample"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
52 <param name="ratio" value="0.05"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
53 <param name="head" value="False"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
54 <output name="output" file="output_obiclean_advanced.fasta.gz" ftype="fasta.gz" decompress="true"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
55 </test>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
56 </tests>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
57 <help><![CDATA[
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
58
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
59 .. class:: infomark
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
60
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
61 **What it does**
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
62
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
63 obijoinpairedend aims at joining the two reads of a paired-end library.
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
64
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
65 For this purpose, it concatenates sequence merging the forward read and the reversed-complemented reverse read.
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
66
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
67 The program uses as input one or two sequences reads files.
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
68
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
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.
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
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.
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
71
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
72 @OBITOOLS_LINK@
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
73
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
74 ]]>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
75 </help>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
76 <expand macro="citation"/>
08d873cdd5f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit dabf62d438facc62f3e606ff4419092fdcdfaa44
iuc
parents: 3
diff changeset
77 </tool>