Mercurial > repos > iuc > umi_tools_extract

annotate macros.xml @ 21:158e9e91b9fc draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit 11a7415c7f8a44a3f990080533c1de43a41d1e2e
author iuc
date Fri, 28 Feb 2025 20:41:17 +0000
parents 14ba4366aca4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
79436b3019e9 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
1 <?xml version="1.0"?>
79436b3019e9 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
2 <macros>
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
3
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
4 <!-- macros applying to all umi_tools -->
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
5
20
14ba4366aca4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit b49b89fc0d2ce62ecee71a6fed06b9c38d3ee645
iuc
parents: 19
diff changeset
6 <token name="@TOOL_VERSION@">1.1.6</token>
14ba4366aca4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit b49b89fc0d2ce62ecee71a6fed06b9c38d3ee645
iuc
parents: 19
diff changeset
7 <token name="@VERSION_SUFFIX@">0</token>
19
7a7e33d28f62 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
iuc
parents: 18
diff changeset
8 <token name="@PROFILE@">23.1</token>
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
9 <xml name="requirements">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
10 <requirements>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
11 <requirement type="package" version="@TOOL_VERSION@">umi_tools</requirement>
21
158e9e91b9fc planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit 11a7415c7f8a44a3f990080533c1de43a41d1e2e
iuc
parents: 20
diff changeset
12 <requirement type="package" version="1.21">samtools</requirement>
158e9e91b9fc planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit 11a7415c7f8a44a3f990080533c1de43a41d1e2e
iuc
parents: 20
diff changeset
13 <requirement type="package" version="4.7">sed</requirement>
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
14 </requirements>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
15 </xml>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
16 <xml name="citations">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
17 <citations>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
18 <citation type="doi">10.1101/gr.209601.116</citation>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
19 <citation type="bibtex">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
20 @misc{githubUMI-tools,
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
21 title = {UMI-tools},
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
22 publisher = {GitHub},
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
23 journal = {GitHub repository},
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
24 url = {https://github.com/CGATOxford/UMI-tools},
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
25 }
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
26 </citation>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
27 </citations>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
28 </xml>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
29 <xml name="advanced_options_macro">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
30 <section name="advanced" title="Extra parameters" expanded="false">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
31 <param argument="--random-seed" type="integer" min="0" optional="true" label="Random Seed" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
32 </section>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
33 </xml>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
34 <token name="@ADVANCED_OPTIONS@"><![CDATA[
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
35 #if str($advanced.random_seed) != ''
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
36 --random-seed='$advanced.random_seed'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
37 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
38 ]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
39
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
40 <!-- macros for extract and whitelist-->
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
41
11
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
42 <macro name="barcode_sanitizer" >
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
43 <sanitizer invalid_char="">
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
44 <valid initial="string.letters,string.digits">
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
45 <add value="&#42;" /><!-- asterisk -->
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
46 <add value="&#44;" /><!-- comma -->
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
47 <add value="&#46;" /><!-- period -->
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
48 <add value="&#60;" /><!-- less than -->
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
49 <add value="&#61;" /><!-- equals sign -->
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
50 <add value="&#62;" /><!-- greater than -->
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
51 <add value="&#63;" /><!-- question mark -->
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
52 <add value="&#95;" /><!-- underscore -->
12
d5ff68d2d5ff "planemo upload commit 5d3fc4232e0e036ac1ed9e2c36adc41d6af4987f"
iuc
parents: 11
diff changeset
53 <add value="&#40;" /><!-- left bracket -->
d5ff68d2d5ff "planemo upload commit 5d3fc4232e0e036ac1ed9e2c36adc41d6af4987f"
iuc
parents: 11
diff changeset
54 <add value="&#41;" /><!-- right bracket -->
d5ff68d2d5ff "planemo upload commit 5d3fc4232e0e036ac1ed9e2c36adc41d6af4987f"
iuc
parents: 11
diff changeset
55 <add value="&#91;"/> <!-- left square bracket -->
d5ff68d2d5ff "planemo upload commit 5d3fc4232e0e036ac1ed9e2c36adc41d6af4987f"
iuc
parents: 11
diff changeset
56 <add value="&#93;"/> <!-- right square bracket -->
11
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
57 <add value="&#123;"/><!-- left brace -->
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
58 <add value="&#125;"/><!-- right brace -->
12
d5ff68d2d5ff "planemo upload commit 5d3fc4232e0e036ac1ed9e2c36adc41d6af4987f"
iuc
parents: 11
diff changeset
59 <add value="&#94;"/> <!-- caret -->
17
f3759eec3018 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit 31bad8c5bf75981eafcd19ec6b00593f184fdeb8"
iuc
parents: 16
diff changeset
60 <add value="&#36;"/> <!-- dollar sign-->
f3759eec3018 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit 31bad8c5bf75981eafcd19ec6b00593f184fdeb8"
iuc
parents: 16
diff changeset
61 <add value="&#43;" /><!-- plus sign -->
12
d5ff68d2d5ff "planemo upload commit 5d3fc4232e0e036ac1ed9e2c36adc41d6af4987f"
iuc
parents: 11
diff changeset
62 <add value="-"/>
d5ff68d2d5ff "planemo upload commit 5d3fc4232e0e036ac1ed9e2c36adc41d6af4987f"
iuc
parents: 11
diff changeset
63 <add value="!"/>
11
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
64 </valid>
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
65 </sanitizer>
a472e995d157 "planemo upload commit 28e58376e1d70e38276873a7d5e2ab44db88c2c0"
iuc
parents: 4
diff changeset
66 </macro>
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
67 <xml name="sanitize_tag" >
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
68 <sanitizer invalid_char="">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
69 <valid initial="string.letters,string.digits" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
70 </sanitizer>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
71 </xml>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
72 <macro name="barcode1_macro" >
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
73 <param argument="--bc-pattern" type="text" label="Barcode pattern for first read"
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
74 help="Use this option to specify the format of the UMI/barcode. Use Ns to
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
75 represent the random positions and Xs to indicate the bc positions.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
76 Bases with Ns will be extracted and added to the read name. Remaining
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
77 bases, marked with an X will be reattached to the read">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
78 <validator type="empty_field" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
79 <expand macro="barcode_sanitizer" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
80 </param>
4
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
81 </macro>
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
82 <macro name="barcode2_macro" >
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
83 <param argument="--bc-pattern2" type="text" value="" label="Barcode pattern for second read"
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
84 help="Use this option to specify the format of the UMI/barcode for
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
85 the second read pair if required" >
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
86 <expand macro="barcode_sanitizer" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
87 </param>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
88 </macro>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
89 <!-- not just fastq because this would allow also fastqcsanger -->
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
90 <token name="@FASTQ_FORMATS@">fastqsanger,fastqsanger.gz,fastqillumina,fastqillumina.gz,fastqsolexa,fastqsolexa.gz</token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
91 <xml name="bio_tools">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
92 <xrefs>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
93 <xref type="bio.tools">umi-tools</xref>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
94 </xrefs>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
95 </xml>
4
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
96 <xml name="input_types">
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
97 <conditional name="input_type_cond">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
98 <param name="input_type" type="select" label="Library type">
4
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
99 <option value="single">Single-end</option>
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
100 <option value="paired">Paired-end</option>
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
101 <option value="paired_collection">Paired-end Dataset Collection</option>
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
102 </param>
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
103 <when value="single">
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
104 <param name="input_read1" type="data" format="@FASTQ_FORMATS@" label="Reads in FASTQ format" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
105 <expand macro="barcode1_macro"/>
4
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
106 </when>
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
107 <when value="paired">
19
7a7e33d28f62 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
iuc
parents: 18
diff changeset
108 <param name="input_read1" type="data" format="@FASTQ_FORMATS@" label="Forward reads in FASTQ format" />
7a7e33d28f62 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
iuc
parents: 18
diff changeset
109 <param name="input_read2" type="data" format="@FASTQ_FORMATS@" label="Reverse reads in FASTQ format" />
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
110 <expand macro="barcode1_macro"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
111 <expand macro="barcode2_macro"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
112 <yield/>
4
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
113 </when>
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
114 <when value="paired_collection">
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
115 <param name="input_readpair" type="data_collection" collection_type="paired" format="@FASTQ_FORMATS@" label="Reads in FASTQ format" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
116 <expand macro="barcode1_macro"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
117 <expand macro="barcode2_macro"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
118 <yield/>
4
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
119 </when>
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
120 </conditional>
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
121 </xml>
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
122 <token name="@COMMAND_LINK@"><![CDATA[
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
123 #set $gz = False
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
124 #if $input_type_cond.input_type == 'single':
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
125 #if $input_type_cond.input_read1.is_of_type("fastq.gz", "fastqsanger.gz"):
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
126 ln -s '$input_type_cond.input_read1' input_single.gz &&
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
127 #set $gz = True
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
128 #else
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
129 ln -s '$input_type_cond.input_read1' input_single.txt &&
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
130 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
131 #elif $input_type_cond.input_type == 'paired':
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
132 #if $input_type_cond.input_read1.is_of_type("fastq.gz", "fastqsanger.gz"):
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
133 ln -s '$input_type_cond.input_read1' input_read1.gz &&
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
134 ln -s '$input_type_cond.input_read2' input_read2.gz &&
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
135 #set $gz = True
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
136 #else
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
137 ln -s '$input_type_cond.input_read1' input_read1.txt &&
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
138 ln -s '$input_type_cond.input_read2' input_read2.txt &&
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
139 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
140 #else ## paired_collection
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
141 #if $input_type_cond.input_readpair.forward.is_of_type("fastq.gz", "fastqsanger.gz"):
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
142 ln -s '$input_type_cond.input_readpair.forward' input_read1.gz &&
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
143 ln -s '$input_type_cond.input_readpair.reverse' input_read2.gz &&
4
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
144 #set $gz = True
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
145 #else
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
146 ln -s '$input_type_cond.input_readpair.forward' input_read1.txt &&
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
147 ln -s '$input_type_cond.input_readpair.reverse' input_read2.txt &&
4
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
148 #end if
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
149 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
150 ]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
151
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
152 <!-- macros for count, dedup, and group -->
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
153
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
154 <token name="@LINK_SAM_BAM_INPUT@"><![CDATA[
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
155 #if $input.is_of_type("sam"):
19
7a7e33d28f62 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
iuc
parents: 18
diff changeset
156 ## sam input is not supported for paired data
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
157 ## https://github.com/CGATOxford/UMI-tools/issues/483
19
7a7e33d28f62 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
iuc
parents: 18
diff changeset
158 ## so convert it to sorted BAM
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
159 ## #set $input_file = $input
19
7a7e33d28f62 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
iuc
parents: 18
diff changeset
160 samtools sort --no-PG '$input' -O BAM > 'input.bam' &&
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
161 samtools index -b 'input.bam' &&
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
162 #set $input_file = 'input.bam'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
163 #else:
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
164 ln -sf '${input}' 'input.bam' &&
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
165 ln -sf '$input.metadata.bam_index' 'input.bam.bai' &&
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
166 #set $input_file = 'input.bam'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
167 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
168 ]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
169 <token name="@SET_INPUT_TYPE@"><![CDATA[
19
7a7e33d28f62 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
iuc
parents: 18
diff changeset
170 ## see comment in LINK_SAM_BAM_INPUT
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
171 ## #if $input.is_of_type("sam"):
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
172 ## --in-sam
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
173 ## #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
174 ]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
175
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
176 <xml name="fastq_barcode_extraction_options_macro">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
177 <conditional name="extract_method_cond">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
178 <param argument="--extract-method" type="select" label="Barcode Extraction Method"
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
179 help="If bracketed expressions are used in the above barcode pattern, then set this to 'regex'. Otherwise leave as 'string'" >
17
f3759eec3018 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit 31bad8c5bf75981eafcd19ec6b00593f184fdeb8"
iuc
parents: 16
diff changeset
180 <option value="string" selected="true">String</option>
f3759eec3018 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit 31bad8c5bf75981eafcd19ec6b00593f184fdeb8"
iuc
parents: 16
diff changeset
181 <option value="regex">Regex</option>
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
182 </param>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
183 <when value="string">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
184 <param argument="--3prime" name="prime3" type="boolean" label="Is barcode on 3' end of the read?"
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
185 truevalue="--3prime" falsevalue=""
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
186 help="By default the barcode is assumed to be on the 5' end of the read, but
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
187 use this option to specify that it is on the 3' end instead.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
188 This option only works with ``--extract-method=string``
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
189 since 3' encoding can be specified explicitly with a regex, e.g
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
190 ``.*(?P&lt;umi_1&gt;.{5})$``" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
191 </when>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
192 <when value="regex">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
193 <param name="filtered_out_bool" type="boolean" label="Write out reads not matching regex pattern"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
194 </when>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
195 </conditional>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
196 <param argument="--ignore-read-pair-suffixes" type="boolean" truevalue="--ignore-read-pair-suffixes" falsevalue="" label="Ignore '\1' and '\2' read name suffixes"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
197 </xml>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
198 <token name="@FASTQ_BARCODE_EXTRACTION_OPTIONS@"><![CDATA[
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
199 ## fastq barcode extraction options:
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
200 --extract-method='$extract_method_cond.extract_method'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
201 --bc-pattern='$input_type_cond.bc_pattern'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
202 #if $input_type_cond.input_type != 'single' and $input_type_cond.bc_pattern2 != ''
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
203 --bc-pattern2='$input_type_cond.bc_pattern2'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
204 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
205 #if $extract_method_cond.extract_method == 'string'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
206 $extract_method_cond.prime3
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
207 #else if $extract_method_cond.filtered_out_bool
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
208 #if $input_type_cond.input_type == 'single':
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
209 --filtered-out='$filtered_out'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
210 #else if $input_type_cond.input_type == 'paired':
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
211 --filtered-out='$filtered_out'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
212 --filtered-out2='$filtered_out_paired'
4
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
213 #else
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
214 --filtered-out='$filtered_out_paired_collection.forward'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
215 --filtered-out2='$filtered_out_paired_collection.reverse'
4
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
216 #end if
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
217 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
218 $ignore_read_pair_suffixes
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
219 ]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
220 <token name="@FASTQ_BARCODE_EXTRACTION_HELP@"><![CDATA[
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
221 There are two methods enabled to extract the umi barcode (+/-
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
222 cell barcode). For both methods, the patterns should be provided
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
223 using the ``--bc-pattern`` and ``--bc-pattern2`` options.x
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
224
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
225 - ``string``
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
226 This should be used where the barcodes are always in the same
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
227 place in the read.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
228
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
229 - N = UMI position (required)
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
230 - C = cell barcode position (optional)
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
231 - X = sample position (optional)
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
232
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
233 Bases with Ns and Cs will be extracted and added to the read
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
234 name. The corresponding sequence qualities will be removed from
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
235 the read. Bases with an X will be reattached to the read.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
236
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
237 E.g. If the pattern is `NNNNCC`,
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
238 Then the read::
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
239
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
240 @HISEQ:87:00000000 read1
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
241 AAGGTTGCTGATTGGATGGGCTAG
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
242 +
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
243 DA1AEBFGGCG01DFH00B1FF0B
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
244
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
245 will become::
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
246
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
247 @HISEQ:87:00000000_TT_AAGG read1
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
248 GCTGATTGGATGGGCTAG
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
249 +
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
250 1AFGGCG01DFH00B1FF0B
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
251
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
252 where 'TT' is the cell barcode and 'AAGG' is the UMI.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
253
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
254 - ``regex``
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
255 This method allows for more flexible barcode extraction and
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
256 should be used where the cell barcodes are variable in
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
257 length. Alternatively, the regex option can also be used to
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
258 filter out reads which do not contain an expected adapter
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
259 sequence. UMI-tools uses the regex module rather than the more
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
260 standard re module since the former also enables fuzzy matching
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
261
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
262 The regex must contain groups to define how the barcodes are
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
263 encoded in the read. The expected groups in the regex are:
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
264
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
265 umi_n = UMI positions, where n can be any value (required)
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
266 cell_n = cell barcode positions, where n can be any value (optional)
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
267 discard_n = positions to discard, where n can be any value (optional)
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
268
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
269 UMI positions and cell barcode positions will be extracted and
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
270 added to the read name. The corresponding sequence qualities
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
271 will be removed from the read.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
272
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
273 Discard bases and the corresponding quality scores will be
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
274 removed from the read. All bases matched by other groups or
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
275 components of the regex will be reattached to the read sequence
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
276
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
277 For example, the following regex can be used to extract reads
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
278 from the Klein et al inDrop data::
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
279
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
280 (?P<cell_1>.{8,12})(?P<discard_1>GAGTGATTGCTTGTGACGCCTT)(?P<cell_2>.{8})(?P<umi_1>.{6})T{3}.*
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
281
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
282 Where only reads with a 3' T-tail and `GAGTGATTGCTTGTGACGCCTT` in
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
283 the correct position to yield two cell barcodes of 8-12 and 8bp
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
284 respectively, and a 6bp UMI will be retained.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
285
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
286 You can also specify fuzzy matching to allow errors. For example if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
287 the discard group above was specified as below this would enable
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
288 matches with up to 2 errors in the discard_1 group.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
289
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
290 ::
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
291
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
292 (?P<discard_1>GAGTGATTGCTTGTGACGCCTT){s<=2}
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
293
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
294 Note that all UMIs must be the same length for downstream
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
295 processing with dedup, group or count commands]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
296
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
297 <xml name="barcode_options_macro">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
298 <conditional name="bc" >
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
299 <param argument="--extract-umi-method" type="select" label="Umi Extract Method" help="How are the barcodes encoded in the read?" >
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
300 <option value="read_id" selected="true">Barcodes are contained at the end of the read seperated by a delimiter</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
301 <option value="tag" >Barcodes are contained in tags</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
302 <option value="umis" >Barcodes were extracted using umis</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
303 </param>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
304 <when value="read_id" >
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
305 <param argument="--umi-separator" type="text" label="Delimiter between read id and the UMI" value="_" >
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
306 <sanitizer invalid_char="" >
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
307 <valid initial="string.punctuation" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
308 </sanitizer>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
309 </param>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
310 </when>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
311 <when value="tag" >
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
312 <param argument="--umi-tag" type="text" label="Tag which contains the UMI" value="RX" >
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
313 <expand macro="sanitize_tag" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
314 </param>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
315 <param argument="--umi-tag-split" type="text" label="Separate the UMI in tag by SPLIT" help="and take the first element"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
316 <param argument="--umi-tag-delimiter" type="text" label="Separate the UMI in tag by DELIMITER" help="and concatenate the elements"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
317 <param argument="--cell-tag" type="text" label="Tag which contains the cell barcode" >
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
318 <expand macro="sanitize_tag" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
319 </param>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
320 <param argument="--cell-tag-split" type="text" label="Separate the cell barcode in tag by SPLIT" help="and take the first element"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
321 <param argument="--cell-tag-delimiter" type="text" label="Separate the cell barcode in tag by DELIMITER" help="and concatenate the elements"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
322 </when>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
323 <when value="umis"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
324 </conditional>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
325 </xml>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
326 <token name="@BARCODE_OPTIONS@"><![CDATA[
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
327 --extract-umi-method $bc.extract_umi_method
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
328 #if str($bc.extract_umi_method) == 'read_id':
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
329 --umi-separator '$bc.umi_separator'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
330 #else if str($bc.extract_umi_method) == 'tag':
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
331 --umi-tag '$bc.umi_tag'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
332 #if $bc.umi_tag_split != ''
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
333 --umi-tag-split '$bc.umi_tag_split'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
334 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
335 #if $bc.umi_tag_delimiter != ''
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
336 --umi-tag-delimiter '$bc.umi_tag_delimiter'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
337 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
338 --cell-tag '$bc.cell_tag'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
339 #if $bc.cell_tag_split != ''
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
340 --cell-tag-split '$bc.cell_tag_split'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
341 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
342 #if $bc.cell_tag_delimiter != ''
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
343 --cell-tag-delimiter '$bc.cell_tag_delimiter'
4
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
344 #end if
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
345 #end if
e73a22ff585c planemo upload commit 76cbd559320d2a639e35ed10cb2d9522a5a77ae0
iuc
parents: 2
diff changeset
346 ]]></token>
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
347 <token name="@BARCODE_HELP@"><![CDATA[
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
348 Extracting barcodes
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
349 -------------------
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
350
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
351 It is assumed that the FASTQ files were processed with ``umi_tools
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
352 extract`` before mapping and thus the UMI is the last word of the read
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
353 name. e.g:
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
354
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
355 @HISEQ:87:00000000_AATT
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
356
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
357 where ``AATT`` is the UMI sequeuence.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
358
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
359 If you have used an alternative method which does not separate the
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
360 read id and UMI with a "_", such as bcl2fastq which uses ":", you can
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
361 specify the separator with the option ``--umi-separator=<sep>``,
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
362 replacing <sep> with e.g ":".
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
363
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
364 Alternatively, if your UMIs are encoded in a tag, you can specify this
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
365 by setting the option --extract-umi-method=tag and set the tag name
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
366 with the --umi-tag option. For example, if your UMIs are encoded in
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
367 the 'UM' tag, provide the following options:
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
368 ``--extract-umi-method=tag`` ``--umi-tag=UM``
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
369
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
370 Finally, if you have used umis to extract the UMI +/- cell barcode,
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
371 you can specify ``--extract-umi-method=umis``
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
372
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
373 The start position of a read is considered to be the start of its alignment
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
374 minus any soft clipped bases. A read aligned at position 500 with
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
375 cigar 2S98M will be assumed to start at position 498.]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
376
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
377
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
378 <xml name="umi_grouping_options_macro">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
379 <section name="umi" title="UMI grouping options">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
380 <param argument="--method" type="select" label="Method used to identify PCR duplicates within reads" help="All methods start by identifying the reads with the same mapping position">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
381 <option value="unique">Reads group share the exact same UMI</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
382 <option value="percentile">Reads group share the exact same UMI. UMIs with counts less than 1% of the median counts for UMIs at the same position are ignored</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
383 <option value="cluster">Identify clusters based on hamming distance</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
384 <option value="adjacency">Identify clusters based on hamming distance and resolve networks by using the node counts</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
385 <option value="directional">Identify clusters based on distance and counts, restrict network expansion by threshold</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
386 </param>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
387 <param argument="--edit-distance-threshold" type="integer" value="1" label="Edit distance threshold" help="For the adjacency and cluster methods the threshold for the edit distance to connect two UMIs in the network can be increased. The default value of 1 works best unless the UMI is very long (&gt;14bp)" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
388 <param argument="--spliced-is-unique" type="boolean" truevalue="--spliced-is-unique" falsevalue="" label="Spliced reads are unique" help="Causes two reads that start in the same position on the same strand and having the same UMI to be considered unique if one is spliced and the other is not. (Uses the 'N' cigar operation to test for splicing)" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
389 <param argument="--soft-clip-threshold" type="integer" value="4" label="Soft clip threshold" help="Mappers that soft clip, will sometimes do so rather than mapping a spliced read if there is only a small overhang over the exon junction. By setting this option, you can treat reads with at least this many bases soft-clipped at the 3' end as spliced" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
390 <param argument="--read-length" type="boolean" truevalue="--read-length" falsevalue="" label="Use the read length as as a criterion when deduping" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
391 </section>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
392 </xml>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
393 <token name="@UMI_GROUPING_OPTIONS@"><![CDATA[
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
394 --method $umi.method
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
395 --edit-distance-threshold $umi.edit_distance_threshold
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
396 $umi.spliced_is_unique
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
397 --soft-clip-threshold $umi.soft_clip_threshold
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
398 $umi.read_length
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
399 ]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
400 <token name="@UMI_GROUPING_HELP@"><![CDATA[
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
401 UMI grouping options
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
402 --------------------
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
403
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
404 Grouping Method
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
405 ...............
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
406
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
407 What method to use to identify group of reads with the same (or
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
408 similar) UMI(s)?
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
409
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
410 All methods start by identifying the reads with the same mapping position.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
411
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
412 The simplest methods, unique and percentile, group reads with
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
413 the exact same UMI. The network-based methods, cluster, adjacency and
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
414 directional, build networks where nodes are UMIs and edges connect UMIs
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
415 with an edit distance <= threshold (usually 1). The groups of reads
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
416 are then defined from the network in a method-specific manner. For all
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
417 the network-based methods, each read group is equivalent to one read
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
418 count for the gene.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
419
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
420 - unique
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
421 Reads group share the exact same UMI
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
422
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
423 - percentile
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
424 Reads group share the exact same UMI. UMIs with counts < 1% of the
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
425 median counts for UMIs at the same position are ignored.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
426
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
427 - cluster
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
428 Identify clusters of connected UMIs (based on hamming distance
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
429 threshold). Each network is a read group
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
430
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
431 - adjacency
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
432 Cluster UMIs as above. For each cluster, select the node (UMI)
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
433 with the highest counts. Visit all nodes one edge away. If all
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
434 nodes have been visited, stop. Otherwise, repeat with remaining
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
435 nodes until all nodes have been visted. Each step
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
436 defines a read group.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
437
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
438 - directional (default)
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
439 Identify clusters of connected UMIs (based on hamming distance
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
440 threshold) and umi A counts >= (2* umi B counts) - 1. Each
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
441 network is a read group.
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
442
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
443 ]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
444
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
445 <xml name="sambam_options_macro">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
446 <section name="sambam" title="SAM/BAM options">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
447 <param argument="--mapping-quality" type="integer" value="0" label="Minimum mapping quality for a read to be retained"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
448 <param argument="--unmapped-reads" type="select" label="How to handle unmapped reads">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
449 <option value="discard">discard</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
450 <option value="use">use</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
451 <option value="correct">correct</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
452 </param>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
453 <param argument="--chimeric-pairs" type="select" optional="true" label="How to handle chimeric read pairs (default: use)">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
454 <option value="discard">discard</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
455 <option value="use">use</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
456 <option value="correct">correct</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
457 </param>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
458 <param argument="--unpaired-reads" type="select" optional="true" label="How to handle unpaired reads (default: use)">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
459 <option value="discard">discard</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
460 <option value="use">use</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
461 <option value="correct">correct</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
462 </param>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
463 <param argument="--ignore-umi" type="boolean" truevalue="--ignore-umi" falsevalue="" label="Ignore UMI and dedup only on position"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
464 <param argument="--ignore-tlen" type="boolean" truevalue="--ignore-tlen" falsevalue="" label="Dedup paired end reads based solely on read1" help="whether or not the template length is the same"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
465 <param argument="--chrom" type="text" value="" label="Consider only chromosome" help="If a value is given only a single chromosome with the given name is considered"/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
466 <param argument="--subset" type="float" min="0.0" max="1.0" value="1.0" label="Only consider a random selection of the reads" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
467 <!--in-sam is set automatically-->
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
468 <param argument="--paired" type="boolean" truevalue="--paired" falsevalue="" label="BAM is paired end" help="This will also force the use of the template length to determine reads with the same mapping coordinates" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
469 </section>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
470 </xml>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
471 <token name="@SAMBAM_OPTIONS@"><![CDATA[
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
472 --mapping-quality $sambam.mapping_quality
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
473 --unmapped-reads $sambam.unmapped_reads
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
474 #if $sambam.chimeric_pairs
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
475 --chimeric-pairs $sambam.chimeric_pairs
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
476 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
477 #if $sambam.unpaired_reads
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
478 --unpaired-reads $sambam.unpaired_reads
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
479 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
480 $sambam.ignore_umi
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
481 $sambam.ignore_tlen
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
482 #if str($sambam.chrom) != ''
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
483 --chrom '$sambam.chrom'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
484 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
485 --subset $sambam.subset
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
486 $sambam.paired
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
487 @SET_INPUT_TYPE@
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
488 ]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
489
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
490 <!-- per-gene is hard coded in count https://github.com/CGATOxford/UMI-tools/blob/c3ead0792ad590822ca72239ef01b8e559802da9/umi_tools/count.py#L92
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
491 hence we need a specialized macro here
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
492 TODO count used XF as default for gene-tag now I set it explicitly for the tests but we could as well parametrize the macro and set tool specific defaults
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
493 -->
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
494
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
495 <xml name="fullsc_options_macro">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
496 <expand macro="sc_options_macro">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
497 <param argument="--per-gene" type="boolean" truevalue="--per-gene" falsevalue="" label="Deduplicate per gene"
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
498 help="Must combine with either --gene-tag or --per-contig. As for --per-contig except with this option you can align to a reference transcriptome with more than one transcript per gene. You need to also provide a map of genes to transcripts. This will also add a metacontig ('MC') tag to the output BAM file" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
499 </expand>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
500 </xml>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
501 <token name="@FULLSC_OPTIONS@"><![CDATA[
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
502 $sc.per_gene
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
503 @SC_OPTIONS@
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
504 ]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
505
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
506 <xml name="sc_options_macro">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
507 <section name="sc" title="Single-cell RNA-Seq options">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
508 <yield/>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
509 <param argument="--gene-tag" type="text" optional="true" label="Deduplicate by this gene tag" help="As --per-gene except here the gene information is encoded in the bam read tag specified so you do not need to supply the mapping file">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
510 <expand macro="sanitize_tag" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
511 </param>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
512 <param argument="--assigned-status-tag" type="text" optional="true" label="Bam tag describing whether read is assigned to a gene" help="By default, this is set as the same tag as --gene-tag">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
513 <expand macro="sanitize_tag" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
514 </param>
19
7a7e33d28f62 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
iuc
parents: 18
diff changeset
515 <param argument="--skip-tags-regex" type="text" label="Skip any reads where the gene matches this tag" value="" >
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
516 <expand macro="barcode_sanitizer" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
517 </param>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
518 <param argument="--per-contig" type="boolean" truevalue="--per-contig" falsevalue="" label="Deduplicate per contig" help="Field 3 in BAM; RNAME. All reads with the same contig will be considered to have the same alignment position. This is useful if your library prep generates PCR duplicates with non identical alignment positions such as CEL-Seq. In this case, you would align to a reference transcriptome with one transcript per gene" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
519 <param argument="--gene-transcript-map" type="data" format="tabular" optional="true" label="Tabular file mapping genes to transripts" />
19
7a7e33d28f62 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
iuc
parents: 18
diff changeset
520 <param argument="--per-cell" type="boolean" truevalue="--per-cell" falsevalue="" label="Group reads only if they have the same cell barcode" />
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
521 </section>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
522 </xml>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
523 <token name="@SC_OPTIONS@"><![CDATA[
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
524 #if str($sc.gene_tag) != "":
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
525 --gene-tag '$sc.gene_tag'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
526 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
527 #if str($sc.assigned_status_tag) != "":
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
528 --assigned-status-tag '$sc.assigned_status_tag'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
529 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
530 #if str($sc.skip_tags_regex) != "":
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
531 --skip-tags-regex '$sc.skip_tags_regex'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
532 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
533 $sc.per_contig
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
534 #if $sc.gene_transcript_map:
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
535 --gene-transcript-map '$sc.gene_transcript_map'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
536 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
537 $sc.per_cell
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
538 ]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
539
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
540 <xml name="groupdedup_options_macro">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
541 <section name="gd" title="group/dedup specific options">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
542 <param argument="--buffer-whole-contig" type="boolean" truevalue="--buffer-whole-contig" falsevalue="" label="Read whole contig before outputting bundles" help="Guarantees that no reads are missed, but increases memory usage" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
543 <!-- TODO this option is hidden on the CLI. Should we expose it? -->
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
544 <param argument="--whole-contig" type="boolean" truevalue="--whole-contig" falsevalue="" label="Consider all alignments to a single contig together" help="This is useful if you have aligned to a transcriptome multi-fasta" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
545 <param argument="--multimapping-detection-method" type="select" optional="true" label="BAM Tag indicating multimapping " help="Some aligners identify multimapping using bam tags. Setting this option to NH, X0 or XT will use these tags when selecting the best read amongst reads with the same position and umi">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
546 <option value="NH">NH</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
547 <option value="X0">X0</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
548 <option value="XT">XT</option>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
549 </param>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
550 </section>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
551 </xml>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
552 <token name="@GROUPDEDUP_OPTIONS@"><![CDATA[
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
553 $gd.buffer_whole_contig
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
554 $gd.whole_contig
21
158e9e91b9fc planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit 11a7415c7f8a44a3f990080533c1de43a41d1e2e
iuc
parents: 20
diff changeset
555 #if $gd.multimapping_detection_method
158e9e91b9fc planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit 11a7415c7f8a44a3f990080533c1de43a41d1e2e
iuc
parents: 20
diff changeset
556 --multimapping-detection-method $gd.multimapping_detection_method
158e9e91b9fc planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit 11a7415c7f8a44a3f990080533c1de43a41d1e2e
iuc
parents: 20
diff changeset
557 #end if
15
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
558 ]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
559
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
560 <xml name="log_input_macro">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
561 <param argument="--log" type="boolean" label="Output log?" truevalue="--log" falsevalue="" help="Choose if you want to generate a text file containing logging information" />
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
562 </xml>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
563 <xml name="log_output_macro">
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
564 <data name="out_log" format="txt" label="${tool.name} on ${on_string}: logfile" >
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
565 <filter>log</filter>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
566 </data>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
567 </xml>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
568 <token name="@LOG@"><![CDATA[
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
569 #if $log:
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
570 --log='$out_log'
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
571 #end if
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
572 --log2stderr
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
573 ]]></token>
27ac32a22ad2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 12
diff changeset
574
1
79436b3019e9 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
575 </macros>