annotate reads_subsampler.xml @ 0:1fbf1bf3d180 draft default tip

planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
author jpayne
date Mon, 08 Dec 2025 20:22:33 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
1 <tool id="reads_subsampler" name="GalaxyTrakr Subsampler" version="1.0.0" python_template_version="3.5">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
2 <description>to reduce excess genomic coverage to specified depth</description>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
3 <requirements>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
4 <requirement type="package" version="3.7">python</requirement>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
5 </requirements>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
6 <command detect_errors="exit_code"><![CDATA[
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
7 #if $reads.reads_select == 'collection'
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
8 python3 ${__tool_directory__}/subsamplr.py '$reads.coll.forward' '$reads.coll.reverse' '$downsampled.forward' '$downsampled.reverse' $coverage $genome_size '$seed'
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
9 #elif $reads.reads_select == 'single'
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
10 python3 ${__tool_directory__}/subsamplr.py '$forward' '$forward_out' $coverage $genome_size '$seed'
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
11 #else
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
12 python3 ${__tool_directory__}/subsamplr.py '$forward' '$reverse' $forward_out $reverse_out $coverage $genome_size '$seed'
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
13 #end if
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
14 ]]></command>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
15 <inputs>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
16 <conditional name="reads">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
17 <param name="reads_select" type="select" label="Paired-end collection, or two datasets from your history">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
18 <option value="collection">Paired collection from your history</option>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
19 <option value="history">Two FASTQ datasets from your history representing paired reads, forward and reverse</option>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
20 <option value="single">One FASTQ dataset representing single-end sequencing</option>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
21 </param>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
22 <when value="collection">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
23 <param label="Paired reads" name="coll" type="data_collection" format="fastq,fastqsanger,fastq.gz,fastqsanger.gz,fastq.bz2,fastqsanger.bz2" collection_type="paired" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
24 </when>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
25 <when value="history">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
26 <param label="Forward reads" type="data" name="forward" format="fastq,fastqsanger,fastq.gz,fastqsanger.gz,fastq.bz2,fastqsanger.bz2" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
27 <param label="Reverse reads" type="data" name="reverse" format="fastq,fastqsanger,fastq.gz,fastqsanger.gz,fastq.bz2,fastqsanger.bz2" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
28 </when>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
29 <when value="single">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
30 <param label="Reads" type="data" name="forward" format="fastq,fastqsanger,fastq.gz,fastqsanger.gz,fastq.bz2,fastqsanger.bz2" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
31 </when>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
32 </conditional>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
33 <param name="coverage" type="integer" label="Maximum Coverage" value="200" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
34 <param name="genome_size" type="select" label="Assumed Genome Size">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
35 <option value="5000000">Salmonella, E. Coli, Vibrio p. (5000000)</option>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
36 <option value="4000000">Vibrio cholerae (4000000)</option>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
37 <option value="2700000">Listeria (2700000)</option>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
38 <option value="1600000">Campylobacter (1600000)</option>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
39 <option value="29900">SARS-CoV-2 (29900)</option>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
40 </param>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
41 <param name="seed" type="text" value="ed2b99d842cddc1ac81d7c01a0bf0555" label="Random seed (you don't have to change this)"/>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
42 </inputs>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
43 <outputs>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
44 <data name="forward_out" label="${reads.forward.name}.downsampled" format_source="forward">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
45 <filter>reads['reads_select'] == "history" or reads['reads_select'] == "single"</filter>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
46 </data>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
47 <data name="reverse_out" label="${reads.reverse.name}.downsampled" format_source="reverse">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
48 <filter>reads['reads_select'] == "history"</filter>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
49 </data>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
50 <collection name="downsampled" type="paired" label="${reads.coll.name}" structured_like="reads|coll" format_source="reads|coll">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
51 <filter>reads['reads_select'] == "collection"</filter>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
52 <data name="forward" label="${reads.coll.forward.name}.downsampled" format_source="reads.coll.forward" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
53 <data name="reverse" label="${reads.coll.reverse.name}.downsampled" format_source="reads.coll.reverse" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
54 </collection>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
55 </outputs>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
56 <tests>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
57 <test>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
58 <conditional name="reads">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
59 <param name="reads_select" value="single" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
60 <param name="forward" value="forward.fastq" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
61 </conditional>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
62 <param name="coverage" value="20" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
63 <param name="genome_size" value="29900" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
64 <output name="forward_out" value="forward_out.fastq" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
65 </test>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
66 <test>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
67 <conditional name="reads">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
68 <param name="reads_select" value="collection" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
69 <param name="coll">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
70 <collection type="paired">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
71 <element name="forward" value="forward.fastq" ftype="fastqsanger" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
72 <element name="reverse" value="reverse.fastq" ftype="fastqsanger" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
73 </collection>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
74 </param>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
75 </conditional>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
76 <param name="coverage" value="20" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
77 <param name="genome_size" value="29900" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
78 <output_collection name="downsampled" type="paired">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
79 <element name="forward" file="forward_out.fastq" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
80 <element name="reverse" file="reverse_out.fastq" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
81 </output_collection>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
82 </test>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
83 <test>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
84 <conditional name="reads">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
85 <param name="reads_select" value="history" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
86 <param name="forward" value="forward.fastq" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
87 <param name="reverse" value="reverse.fastq" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
88 </conditional>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
89 <param name="coverage" value="20" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
90 <param name="genome_size" value="29900" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
91 <output name="forward_out" value="forward_out.fastq" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
92 <output name="reverse_out" value="reverse_out.fastq" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
93 </test>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
94 <test>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
95 <conditional name="reads">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
96 <param name="reads_select" value="history" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
97 <param name="forward" value="forward.fastq.gz" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
98 <param name="reverse" value="reverse.fastq.gz" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
99 </conditional>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
100 <param name="coverage" value="20" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
101 <param name="genome_size" value="29900" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
102 <output name="forward_out" value="forward_out.fastq.gz" decompress="true" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
103 <output name="reverse_out" value="reverse_out.fastq.gz" decompress="true" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
104 </test>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
105 <test>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
106 <conditional name="reads">
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
107 <param name="reads_select" value="history" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
108 <param name="forward" value="forward.fastq.bz2" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
109 <param name="reverse" value="reverse.fastq.bz2" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
110 </conditional>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
111 <param name="coverage" value="20" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
112 <param name="genome_size" value="29900" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
113 <output name="forward_out" value="forward_out.fastq.bz2" decompress="true" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
114 <output name="reverse_out" value="reverse_out.fastq.bz2" decompress="true" />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
115 </test>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
116 </tests>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
117 <help><![CDATA[
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
118 Randomly subsample single or paired-end FASTQ reads to target a certain genomic coverage depth.
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
119 ]]></help>
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
120 <citations />
1fbf1bf3d180 planemo upload commit 1f45ac19d30ec5c5bf7d44a0b09990369a139668
jpayne
parents:
diff changeset
121 </tool>