annotate ampligone.xml @ 0:d5fc5d888a46 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
author iuc
date Tue, 29 Jul 2025 10:18:37 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
1 <tool id="ampligone" name="AmpliGone" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="23.2">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
2 <description>Find and remove primers from NGS amplicon reads</description>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
3 <macros>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
4 <token name="@TOOL_VERSION@">2.0.1</token>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
5 <token name="@VERSION_SUFFIX@">0</token>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
6 </macros>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
7 <requirements>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
8 <requirement type="package" version="@TOOL_VERSION@">AmpliGone</requirement>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
9 </requirements>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
10 <version_command>ampligone --version</version_command>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
12 #import re
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
13
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
14 #set $inputs_map = {
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
15 'input': 'reads',
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
16 'reference': 'reference',
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
17 'primers': 'primers'
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
18 }
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
19
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
20 #for $key, $short in $inputs_map.items()
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
21 #set $ds = $inputs[$key]
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
22 #set $ext = re.sub("sanger", "", $ds.ext)
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
23 #set $is_gz = str($ds.ext).endswith('.gz') and $ext != 'bam'
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
24 #set $filename = $short + '.' + $ext
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
25
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
26 ln -sf '$ds' '$filename' &&
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
27 #silent $inputs_map[$key] = $filename
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
28
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
29 #if $key == 'input'
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
30 #set $output_name = 'output.fastq' + ('.gz' if $is_gz else '')
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
31 touch '$cleaned' &&
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
32 ln -sf '$cleaned' $output_name &&
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
33 #end if
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
34 #end for
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
35
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
36 #if $inputs.primers.ext == 'fasta' and $inputs.export_primers == 'yes'
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
37 #set $primer_filename = 'primers.bed'
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
38 touch '$exp_prim' &&
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
39 ln -sf '$exp_prim' $primer_filename &&
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
40 #end if
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
41
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
42 ## --- Run the tool using clean and predictable filenames ---
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
43 ampligone
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
44 ##add input files
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
45 --input '$inputs_map['input']'
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
46 --reference '$inputs_map['reference']'
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
47 --primers '$inputs_map['primers']'
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
48
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
49 ## Compute options
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
50 --threads "\${GALAXY_SLOTS:-2}"
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
51
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
52 ##optional arguments
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
53
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
54 #if $opt_args.ampli_type.amplicon_type
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
55 --amplicon-type $opt_args.ampli_type.amplicon_type
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
56 #end if
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
57 #if $opt_args.ampli_type.amplicon_type == 'fragmented'
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
58 --fragment-lookaround-size $opt_args.ampli_type.fragment_lookaround_size
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
59 #end if
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
60 #if $opt_args.error_rate
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
61 --error-rate $opt_args.error_rate
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
62 #end if
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
63
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
64 ##output options
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
65 #if $inputs.primers.ext == 'fasta' and $inputs.export_primers == 'yes'
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
66 --export-primers '$primer_filename'
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
67 #end if
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
68
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
69 --output '$output_name'
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
70
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
71 ]]></command>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
72 <inputs>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
73 <section name="inputs" title="Inputs" expanded="true">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
74 <param argument="--input" type="data" format="fastqsanger,fastqsanger.gz,bam" label="Input file" help="Input file with reads in FASTQ format."/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
75 <param argument="--reference" type="data" format="fasta" label="Reference genome" help="Input Reference genome in FASTA format." />
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
76 <param argument="--primers" type="data" format="fasta,bed" label="Used primer sequences" help="Used primer sequences in FASTA or BED format." />
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
77 <param argument="--export-primers" type="boolean" checked="false" truevalue="yes" falsevalue="no" optional="true" label="Output cut primers coordinates" help="Output BED file with found primer coordinates if they are actually cut from the reads."/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
78 </section>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
79
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
80 <section name="opt_args" title="Optional Arguments" expanded="false">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
81 <conditional name="ampli_type">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
82 <param argument="--amplicon-type" type="select" label="Define the amplicon-type" help="Define the amplicon-type, either being 'end-to-end', 'end-to-mid', or 'fragmented'. See the docs for more info.">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
83 <option value="end-to-end" selected="true">end-to-end</option>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
84 <option value="end-to-mid">end-to-mid</option>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
85 <option value="fragmented">fragmented</option>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
86 </param>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
87 <when value="fragmented">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
88 <param argument="--fragment-lookaround-size" type="integer" value="10" optional="true" label="Fragment lookaround size" help="The number of bases to look around a primer-site to consider it part of a fragment." />
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
89 </when>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
90 <when value="end-to-end"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
91 <when value="end-to-mid"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
92 </conditional>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
93 <param argument="--error-rate" type="float" min="0" max="1" value="0.1" label="Error rate" help="The maximum allowed error rate for the primer search. Use 0 for exact primer matches." />
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
94 </section>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
95 </inputs>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
96
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
97 <outputs>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
98 <data name="cleaned" format="fastqsanger" label="${tool.name} on ${inputs.input.name} ($on_string): Cleaned reads"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
99 <data name="exp_prim" format="bed" label="${tool.name} on ${on_string}: Detected primer coordinates">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
100 <filter>inputs['primers'].ext == 'fasta' and inputs['export_primers'] is True</filter>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
101 </data>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
102 </outputs>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
103 <tests>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
104 <test expect_num_outputs="1">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
105 <section name="inputs">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
106 <param name="input" value="sars-cov-2.fastq"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
107 <param name="reference" value="SARS-CoV-2-reference.fasta"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
108 <param name="primers" value="SARS-CoV-2-ARTIC-V5.3.2.scheme.bed" />
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
109 </section>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
110 <output name="cleaned">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
111 <assert_contents>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
112 <has_text text="@SRR30635841.1"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
113 <has_text text="@SRR30635841.2"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
114 <has_text text="@SRR30635841.3"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
115 <has_text text="@SRR30635841.4"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
116 <has_text text="@SRR30635841.5"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
117 </assert_contents>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
118 </output>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
119 </test>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
120 <test expect_num_outputs="2">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
121 <section name="inputs">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
122 <param name="input" value="sars-cov-2.fastq"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
123 <param name="reference" value="SARS-CoV-2-reference.fasta"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
124 <param name="primers" value="ARTIC-V5.3.2.fasta" />
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
125 <param name="export_primers" value="yes"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
126 </section>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
127 <output name="cleaned">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
128 <assert_contents>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
129 <has_text text="@SRR30635841.1"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
130 <has_text text="@SRR30635841.2"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
131 <has_text text="@SRR30635841.3"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
132 <has_text text="@SRR30635841.4"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
133 <has_text text="@SRR30635841.5"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
134 </assert_contents>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
135 </output>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
136 <output name="exp_prim">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
137 <assert_contents>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
138 <has_text text="MN908947.3:6204-6237_LEFT"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
139 <has_text text="MN908947.3:25744-25777_RIGHT"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
140 </assert_contents>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
141 </output>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
142 </test>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
143 <test expect_num_outputs="1">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
144 <section name="inputs">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
145 <param name="input" value="synthetic.bam"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
146 <param name="reference" value="synthetic.fasta"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
147 <param name="primers" value="synthetic.bed" />
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
148 </section>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
149 <output name="cleaned">
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
150 <assert_contents>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
151 <has_text text="read_number_2_last_120_of_ref"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
152 <has_text text="read_number_1_first_120_of_ref"/>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
153 </assert_contents>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
154 </output>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
155 </test>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
156 </tests>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
157 <help><![CDATA[
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
158 **AmpliGone**
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
159
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
160 In contrast to a lot of other primer-removal tools, AmpliGone does not actively look for primer sequences within the NGS reads. When providing BED input, reads are trimmed based on primer sequence coordinates in relation to a given reference sequence. Additionally, AmpliGone is able to compensate for, and therefore properly clean, reads that start or end outside of a primer-region as this is a common occurrence in amplicon-based sequencing data.
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
161 AmpliGone works with both reads in FASTQ format, as well as aligned data in BAM-format. However, when data is presented in the BAM-format then only read-data (sequence and quality scores) will be used. Other data present in the BAM-format will not be used in this version of AmpliGone.
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
162
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
163 Currently, AmpliGone supports Nanopore data and Illumina data. The Illumina platform (NextSeq/MiSeq/HiSeq/other) does not matter.
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
164
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
165 It is however important that you know the read-length in relation to the amplicon length. AmpliGone expects this information in the form of an 'amplicon-type'.
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
166
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
167 AmpliGone is build and tested with Nanopore and Illumina data (fastq) in mind and supports 'end-to-end', 'end-to-mid' and 'fragmented' amplicons to be cleaned.
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
168
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
169
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
170 **More Information**
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
171
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
172 - **Official Repository**: https://github.com/RIVM-bioinformatics/AmpliGone
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
173 - **Extended User Guide**: https://rivm-bioinformatics.github.io/AmpliGone/@TOOL_VERSION@/
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
174
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
175 ]]></help>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
176 <citations>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
177 <citation type="doi">10.5281/zenodo.7684307</citation>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
178 </citations>
d5fc5d888a46 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampligone commit 5bd763da003ce033467702f2fb4dca5264e0be43
iuc
parents:
diff changeset
179 </tool>