Mercurial > repos > iuc > umi_tools_group

annotate umi-tools_group.xml @ 17:428735be9764 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 bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
author iuc
date Sat, 05 Oct 2024 13:08:51 +0000
parents 257be15474a7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
1 <tool id="umi_tools_group" name="UMI-tools group" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
2 <description>Extract UMI from fastq files</description>
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
3 <macros>
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
4 <import>macros.xml</import>
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
5 </macros>
17
428735be9764 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
iuc
parents: 16
diff changeset
6 <expand macro="bio_tools"/>
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
7 <expand macro="requirements">
16
257be15474a7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit be699fdf0360f0535f52564e5b59be9b84712b14
iuc
parents: 13
diff changeset
8 <requirement type="package" version="1.21">samtools</requirement>
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
9 </expand>
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
11 @LINK_SAM_BAM_INPUT@
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
12
1
f73f13641bb6 planemo upload commit eea727c3bdfe36d9d16036d5ab79fb8b27c4e82e
iuc
parents: 0
diff changeset
13 umi_tools group
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
14 #if $group_output:
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
15 --group-out '$group_out'
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
16 #end if
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
17 --output-bam
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
18 @GROUPDEDUP_OPTIONS@
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
19 @BARCODE_OPTIONS@
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
20 @UMI_GROUPING_OPTIONS@
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
21 @SAMBAM_OPTIONS@
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
22 @FULLSC_OPTIONS@
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
23 -I '$input_file' -S grouped.bam
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
24 @ADVANCED_OPTIONS@
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
25 @LOG@
17
428735be9764 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
iuc
parents: 16
diff changeset
26 ## using samtools sort is a workaround, for the following error that appears when Galaxy
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
27 ## compares the generated file with the one in test-data
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
28 ## `Converting history BAM to SAM failed: 'samtools returned with error 1: stdout=None, stderr=[main_samview] fail to read the header from "/tmp/tmpd8o61jykdedup_out6.bam".\n'. Will compare BAM files`
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
29 ## may be dropped in the future
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
30 --no-sort-output
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
31 && samtools sort --no-PG grouped.bam -@ \${GALAXY_SLOTS:-1} -T "\${TMPDIR:-.}" -o '$output' -O BAM
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
32 ]]></command>
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
33 <inputs>
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
34 <param name="input" type="data" format="sam,bam" label="Reads to group in SAM or BAM format" />
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
35 <param name="group_output" argument="--group-out" type="boolean" truevalue="--group-out" falsevalue="" label="Output a flatfile describing the read groups" />
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
36 <expand macro="groupdedup_options_macro"/>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
37 <expand macro="barcode_options_macro"/>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
38 <expand macro="umi_grouping_options_macro"/>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
39 <expand macro="sambam_options_macro"/>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
40 <expand macro="fullsc_options_macro"/>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
41 <expand macro="advanced_options_macro"/>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
42 <expand macro="log_input_macro"/>
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
43 </inputs>
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
44 <outputs>
17
428735be9764 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
iuc
parents: 16
diff changeset
45 <data format="bam" name="output" label="${tool.name} on ${on_string}: Tagged BAM"/>
428735be9764 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bc1b362f6783d3fc0ed0f42c14687001d7ff5f7a
iuc
parents: 16
diff changeset
46 <data format="tabular" name="group_out" label="${tool.name} on ${on_string}: Read groups">
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
47 <filter>group_output</filter>
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
48 </data>
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
49 <expand macro="log_output_macro"/>
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
50 </outputs>
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
51 <tests>
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
52 <test expect_num_outputs="1">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
53 <param name="input" value="group_in2.sam" ftype="sam" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
54 <section name="advanced">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
55 <param name="random_seed" value="0" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
56 </section>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
57 <conditional name="bc">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
58 <param name="extract_umi_method" value="read_id" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
59 </conditional>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
60 <section name="sambam">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
61 <param name="paired" value="true" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
62 </section>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
63 <section name="umi">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
64 <param name="method" value="unique" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
65 </section>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
66 <output name="output" file="group_out2.bam" ftype="bam" />
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
67 </test>
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
68 <test expect_num_outputs="2">
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
69 <param name="input" value="group_in3.bam" ftype="bam" />
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
70 <section name="advanced">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
71 <param name="random_seed" value="0" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
72 </section>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
73 <conditional name="bc">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
74 <param name="extract_umi_method" value="read_id" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
75 </conditional>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
76 <param name="group_output" value="true" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
77 <section name="umi">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
78 <param name="method" value="unique" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
79 </section>
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
80 <output name="group_out" file="group_out3.tab" />
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
81 <output name="output" file="group_out3.bam" ftype="bam" />
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
82 </test>
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
83 <test expect_num_outputs="2">
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
84 <param name="input" value="group_in4.bam" ftype="bam" />
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
85 <section name="advanced">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
86 <param name="random_seed" value="0" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
87 </section>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
88 <conditional name="bc">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
89 <param name="extract_umi_method" value="tag" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
90 <param name="umi_tag" value="BX" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
91 </conditional>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
92 <param name="group_output" value="true" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
93 <section name="umi">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
94 <param name="method" value="unique" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
95 </section>
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
96 <output name="group_out" file="group_out4.tab" />
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
97 <output name="output" file="group_out4.bam" ftype="bam" />
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
98 </test>
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
99 <test expect_num_outputs="1">
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
100 <param name="input" value="group_in5.bam" ftype="bam" />
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
101 <section name="advanced">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
102 <param name="random_seed" value="0" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
103 </section>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
104 <conditional name="bc">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
105 <param name="extract_umi_method" value="read_id" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
106 </conditional>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
107 <section name="umi">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
108 <param name="method" value="cluster" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
109 </section>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
110 <output name="output" file="group_out5.bam" ftype="bam"/>
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
111 </test>
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
112 <test expect_num_outputs="1">
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
113 <param name="input" value="group_in6.bam" ftype="bam" />
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
114 <section name="advanced">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
115 <param name="random_seed" value="0" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
116 </section>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
117 <conditional name="bc">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
118 <param name="extract_umi_method" value="read_id" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
119 </conditional>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
120 <section name="umi">
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
121 <param name="method" value="directional" />
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
122 </section>
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
123 <output name="output" file="group_out6.bam" ftype="bam"/>
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
124 </test>
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
125 </tests>
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
126 <help><![CDATA[
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
127 umi_tools group - Group reads based on their UMI
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
128 ================================================
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
129
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
130 Purpose
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
131 -------
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
132
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
133 The purpose of this command is to identify groups of reads based on
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
134 their genomic coordinate and UMI.
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
135
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
136 The group command can be used to create two types of outfile: a tagged
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
137 BAM or a flatfile describing the read groups
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
138
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
139 To generate the tagged-BAM file, use the option --output-bam and
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
140 provide a filename with the -S option. Alternatively, if you do not
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
141 provide a filename, the bam file will be outputted to the stdout. If
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
142 you have provided the --log/-L option to send the logging output
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
143 elsewhere, you can pipe the output from the group command directly to
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
144 e.g samtools sort like so:
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
145
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
146 ``umi_tools group -I inf.bam --group-out=grouped.tsv --output-bam --log=group.log --paired | samtools sort - -o grouped_sorted.bam``
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
147
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
148 The tagged-BAM file will have two tagged per read:
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
149
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
150 - UG = Unique_id.
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
151 0-indexed unique id number for each group of reads with the same genomic position and UMI or UMIs inferred to be from the same true UMI + errors
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
152
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
153 - BX = Final UMI.
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
154 The inferred true UMI for the group
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
155
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
156 To generate the flatfile describing the read groups, include the
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
157 --group-out=<filename> option. The columns of the read groups file are
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
158 below. The first five columns relate to the read. The final 3 columns
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
159 relate to the group.
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
160
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
161 - read_id
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
162 read identifier
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
163
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
164 - contig
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
165 alignment contig
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
166
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
167 - position
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
168 Alignment position. Note that this position is not the start position of the read in the BAM file but the start of the read taking into account the read strand and cigar
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
169
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
170 - umi
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
171 The read UMI
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
172
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
173 - umi_count
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
174 The number of times this UMI is observed for reads at the same position
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
175
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
176 - final_umi
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
177 The inferred true UMI for the group
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
178
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
179 - final_umi_count
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
180 The total number of reads within the group
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
181
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
182 - unique_id
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
183 The unique id for the group
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
184
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
185 @BARCODE_HELP@
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
186
13
cf25b50eff0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/umi_tools commit bf6a3aa532e8f9d122da4c1e39f3e256ae587b79"
iuc
parents: 11
diff changeset
187 @UMI_GROUPING_HELP@
0
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
188 ]]></help>
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
189 <expand macro="citations" />
860bc357b678 planemo upload commit c8e46ecad0b1473097517e582ed6c43eb0635b36
iuc
parents:
diff changeset
190 </tool>