annotate std.xml @ 0:1ddab994fcee draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
author iuc
date Tue, 05 Aug 2025 09:21:07 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
1 <tool id="pimento_std" name="PIMENTO Standard primer matching" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" license="@LICENSE@">
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
2 <description>Finds best-matching primers in reads using a fuzzy search against a standard primer library</description>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
3 <macros>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
4 <import>macros.xml</import>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
5 </macros>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
6 <expand macro="creators"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
7 <expand macro="requirements"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
8 <command detect_errors="aggressive"><![CDATA[
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
9 #if $primers:
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
10 mkdir primers &&
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
11 cp '$primers' primers &&
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
12 pimento std -i '$input_reads' -p primers --minimum_primer_threshold $minimum_primer_threshold $merged -o sample
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
13 #else
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
14 pimento std -i '$input_reads' --minimum_primer_threshold $minimum_primer_threshold $merged -o sample
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
15 #end if
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
16 ]]></command>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
17 <inputs>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
18 <param name="input_reads" type="data" label="Input reads" format="fastqsanger.gz"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
19 <param name="primers" type="data" label="Input standard primers" format="fasta" optional="true"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
20 <param argument="--minimum_primer_threshold" type="float" value="0.6" min="0.1" max="1.0" label="Minimum primer threshold" help="Any primers with a read proportion lower than this threshold are disregarded"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
21 <param argument="--merged" type="boolean" truevalue="--merged" falsevalue="" help="Necessary if the input sequence file is made up of merged paired-end or single-end reads"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
22 </inputs>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
23 <outputs>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
24 <data name="fasta_output" label="${tool.name} on ${on_string}: FASTA containing best found single or pairs of primers" format="fasta" from_work_dir="sample_std_primers.fasta"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
25 <data name="best_found_primers" label="${tool.name} on ${on_string}: Best found primers" format="txt" from_work_dir="sample_std_primer_out.txt"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
26 <data name="searched_primers" label="${tool.name} on ${on_string}: Every single searched primer" format="txt" from_work_dir="all_standard_primer_proportions.txt"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
27 </outputs>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
28 <tests>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
29 <test expect_num_outputs="3">
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
30 <param name="input_reads" value="test.fastq.gz"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
31 <param name="minimum_primer_threshold" value="0.6"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
32 <param name="merged" value="true"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
33 <output name="fasta_output">
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
34 <assert_contents>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
35 <has_line line=">341F"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
36 <has_line line="CCTACGGGNGGCWGCAG"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
37 <has_n_lines n="4"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
38 </assert_contents>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
39 </output>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
40 <output name="best_found_primers">
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
41 <assert_contents>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
42 <has_line line="V3-V4"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
43 <has_line line="341F: 0.984"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
44 <has_line line="805R: 0.948"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
45 </assert_contents>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
46 </output>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
47 <output name="searched_primers">
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
48 <assert_contents>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
49 <has_line line="V3;341F:0.984"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
50 <has_line line="V3;338F:0.0"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
51 <has_n_lines n="148"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
52 </assert_contents>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
53 </output>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
54 </test>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
55 </tests>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
56 <help><![CDATA[
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
57 Runs the standard primer matching strategy for primer inference. A library
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
58 of standard primers will be searched in input reads using fuzzy regex to
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
59 identify primers with high degrees of proportions. The best single, or pair,
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
60 of primers found will be outputted into a FASTA file (provided any were
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
61 indeed found). PIMENTO comes with its own standard primer library which will
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
62 be used as a default. Users can however give their own custom input library,
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
63 or extend the default library to suit their needs.
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
64 ]]></help>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
65 <expand macro="citations"/>
1ddab994fcee planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/pimento commit 69888afa40f5ac6a42fa9335cf61f0bb6387eb2f
iuc
parents:
diff changeset
66 </tool>