annotate bwa_macros.xml @ 13:ceed4b724f0b draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit 777181bd04849dab271ee2cc95e45c182947d308"
author iuc
date Tue, 19 May 2020 15:25:41 +0000
parents 6def3ba376a7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
1 <macros>
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
2 <import>read_group_macros.xml</import>
2
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
3
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
4 <token name="@VERSION@">0.7.17</token>
2
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
5
11
6def3ba376a7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit 9bbf35d7f47e5ab6b78248c9907b71446d4e7b0c
iuc
parents: 10
diff changeset
6 <token name="@pipefail@"><![CDATA[set -o | grep -q pipefail && set -o pipefail;]]></token>
6def3ba376a7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit 9bbf35d7f47e5ab6b78248c9907b71446d4e7b0c
iuc
parents: 10
diff changeset
7
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
8 <token name="@set_rg_string@">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
9 #set $rg_string = "@RG\\tID:" + str($rg_id)
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
10 #set $rg_string += $format_read_group("\\tSM:", $rg_sm)
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
11 #set $rg_string += $format_read_group("\\tPL:", $rg_pl)
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
12 #set $rg_string += $format_read_group("\\tLB:", $rg_lb)
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
13 #set $rg_string += $format_read_group("\\tCN:", $rg_cn)
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
14 #set $rg_string += $format_read_group("\\tDS:", $rg_ds)
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
15 #set $rg_string += $format_read_group("\\tDT:", $rg_dt)
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
16 #set $rg_string += $format_read_group("\\tFO:", $rg_fo)
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
17 #set $rg_string += $format_read_group("\\tKS:", $rg_ks)
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
18 #set $rg_string += $format_read_group("\\tPG:", $rg_pg)
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
19 #set $rg_string += $format_read_group("\\tPI:", $rg_pi)
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
20 #set $rg_string += $format_read_group("\\tPU:", $rg_pu)
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
21 </token>
0
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
22
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
23 <token name="@set_reference_fasta_filename@"><![CDATA[
2
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
24 #if str( $reference_source.reference_source_selector ) == "history":
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
25 #set $reference_fasta_filename = "localref.fa"
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
26 ln -s '${reference_source.ref_file}' '${reference_fasta_filename}' &&
2
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
27 bwa index
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
28 #if str($reference_source.index_a) != 'auto'
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
29 -a ${reference_source.index_a}
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
30 #end if
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
31 '${reference_fasta_filename}' &&
2
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
32 #else:
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
33 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
34 #end if
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
35 ]]></token>
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
36
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
37 <xml name="requirements">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
38 <requirements>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
39 <requirement type="package" version="@VERSION@">bwa</requirement>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
40 <requirement type="package" version="1.6">samtools</requirement>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
41 </requirements>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
42 </xml>
0
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
43
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
44 <xml name="stdio">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
45 <stdio>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
46 <exit_code range="1:" />
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
47 <exit_code range=":-1" />
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
48 <regex match="Error:" />
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
49 <regex match="Exception:" />
9
a628f5606f68 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit a161a3a7e9149a5ba63fe20f435cd2f275dce4c8
iuc
parents: 8
diff changeset
50 <regex match="\[bns_restore_core\] Parse error reading" />
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
51 </stdio>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
52 </xml>
0
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
53
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
54 <macro name="reference_source_conditional">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
55 <conditional name="reference_source">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
56 <param name="reference_source_selector" type="select" label="Will you select a reference genome from your history or use a built-in index?" help="Built-ins were indexed using default options. See `Indexes` section of help below">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
57 <option value="cached">Use a built-in genome index</option>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
58 <option value="history">Use a genome from history and build index</option>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
59 </param>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
60 <when value="cached">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
61 <param name="ref_file" type="select" label="Using reference genome" help="Select genome from the list">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
62 <options from_data_table="bwa_mem_indexes">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
63 <filter type="sort_by" column="2" />
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
64 <validator type="no_options" message="No indexes are available" />
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
65 </options>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
66 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
67 </param>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
68 </when>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
69 <when value="history">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
70 <param name="ref_file" type="data" format="fasta" label="Use the following dataset as the reference sequence" help="You can upload a FASTA sequence to the history and use it as reference" />
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
71 <param name="index_a" type="select" label="Algorithm for constructing the BWT index" help="(-a)">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
72 <option value="auto">Auto. Let BWA decide the best algorithm to use</option>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
73 <option value="is">IS linear-time algorithm for constructing suffix array. It requires 5.37N memory where N is the size of the database. IS is moderately fast, but does not work with database larger than 2GB</option>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
74 <option value="bwtsw">BWT-SW algorithm. This method works also with big genomes</option>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
75 </param>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
76 </when>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
77 </conditional>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
78 </macro>
2
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
79
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
80 <macro name="dbKeyActionsBwaMem">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
81 <expand macro="dbKeyActions">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
82 <option type="from_data_table" name="bwa_mem_indexes" column="1" offset="0">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
83 <filter type="param_value" column="0" value="#" compare="startswith" keep="False"/>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
84 <filter type="param_value" ref="reference_source.ref_file" column="0"/>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
85 </option>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
86 </expand>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
87 </macro>
0
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
88
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
89 <macro name="dbKeyActions">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
90 <actions>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
91 <conditional name="reference_source.reference_source_selector">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
92 <when value="cached">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
93 <action type="metadata" name="dbkey">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
94 <yield />
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
95 </action>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
96 </when>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
97 <when value="history">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
98 <action type="metadata" name="dbkey">
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
99 <option type="from_param" name="reference_source.ref_file" param_attribute="dbkey" />
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
100 </action>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
101 </when>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
102 </conditional>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
103 </actions>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
104 </macro>
0
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
105
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
106 <token name="@RG@">
0
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
107 -----
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
108
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
109 .. class:: warningmark
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
110
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
111 **Read Groups are Important!**
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
112
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
113 One of the recommended best practices in NGS analysis is adding read group information to BAM files. You can do this directly in BWA interface using the
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
114 **Specify read group information?** widget. If you are not familiar with read groups you shold know that this is effectively a way to tag reads with an additional ID.
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
115 This allows you to combine BAM files from, for example, multiple BWA runs into a single dataset. This significantly simplifies downstream processing as
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
116 instead of dealing with multiple datasets you only have to handle only one. This is possible because the read group information allows you to identify
13
ceed4b724f0b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit 777181bd04849dab271ee2cc95e45c182947d308"
iuc
parents: 11
diff changeset
117 data from different experiments even if they are combined in one file. Many downstream analysis tools such as variant callers (e.g., FreeBayes or Naive Variant Caller
ceed4b724f0b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit 777181bd04849dab271ee2cc95e45c182947d308"
iuc
parents: 11
diff changeset
118 present in Galaxy) are aware of read groups and will automatically generate calls for each individual sample even if they are combined within a single file.
0
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
119
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
120 **Description of read groups fields**
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
121
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
122 (from GATK FAQ webpage):
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
123
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
124 .. csv-table::
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
125 :header-rows: 1
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
126
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
127 Tag,Importance,Definition,Meaning
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
128 "ID","Required","Read group identifier. Each @RG line must have a unique ID. The value of ID is used in the RG tags of alignment records. Must be unique among all read groups in header section. Read group IDs may be modified when merging SAM files in order to handle collisions.","Ideally, this should be a globally unique identify across all sequencing data in the world, such as the Illumina flowcell + lane name and number. Will be referenced by each read with the RG:Z field, allowing tools to determine the read group information associated with each read, including the sample from which the read came. Also, a read group is effectively treated as a separate run of the NGS instrument in tools like base quality score recalibration (a GATK component) -- all reads within a read group are assumed to come from the same instrument run and to therefore share the same error model."
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
129 "SM","Sample. Use pool name where a pool is being sequenced.","Required. As important as ID.","The name of the sample sequenced in this read group. GATK tools treat all read groups with the same SM value as containing sequencing data for the same sample. Therefore it's critical that the SM field be correctly specified, especially when using multi-sample tools like the Unified Genotyper (a GATK component)."
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
130 "PL","Platform/technology used to produce the read. Valid values: ILLUMINA, SOLID, LS454, HELICOS and PACBIO.","Important. Not currently used in the GATK, but was in the past, and may return. The only way to known the sequencing technology used to generate the sequencing data","It's a good idea to use this field."
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
131 "LB","DNA preparation library identify","Essential for MarkDuplicates","MarkDuplicates uses the LB field to determine which read groups might contain molecular duplicates, in case the same DNA library was sequenced on multiple lanes."
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
132
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
133
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
134 **Example of Read Group usage**
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
135
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
136 Suppose we have a trio of samples: MOM, DAD, and KID. Each has two DNA libraries prepared, one with 400 bp inserts and another with 200 bp inserts. Each of these libraries is run on two lanes of an illumina hiseq, requiring 3 x 2 x 2 = 12 lanes of data. When the data come off the sequencer, we would create 12 BAM files, with the following @RG fields in the header::
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
137
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
138 Dad's data:
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
139 @RG ID:FLOWCELL1.LANE1 PL:illumina LB:LIB-DAD-1 SM:DAD PI:200
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
140 @RG ID:FLOWCELL1.LANE2 PL:illumina LB:LIB-DAD-1 SM:DAD PI:200
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
141 @RG ID:FLOWCELL1.LANE3 PL:illumina LB:LIB-DAD-2 SM:DAD PI:400
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
142 @RG ID:FLOWCELL1.LANE4 PL:illumina LB:LIB-DAD-2 SM:DAD PI:400
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
143
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
144 Mom's data:
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
145 @RG ID:FLOWCELL1.LANE5 PL:illumina LB:LIB-MOM-1 SM:MOM PI:200
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
146 @RG ID:FLOWCELL1.LANE6 PL:illumina LB:LIB-MOM-1 SM:MOM PI:200
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
147 @RG ID:FLOWCELL1.LANE7 PL:illumina LB:LIB-MOM-2 SM:MOM PI:400
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
148 @RG ID:FLOWCELL1.LANE8 PL:illumina LB:LIB-MOM-2 SM:MOM PI:400
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
149
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
150 Kid's data:
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
151 @RG ID:FLOWCELL2.LANE1 PL:illumina LB:LIB-KID-1 SM:KID PI:200
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
152 @RG ID:FLOWCELL2.LANE2 PL:illumina LB:LIB-KID-1 SM:KID PI:200
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
153 @RG ID:FLOWCELL2.LANE3 PL:illumina LB:LIB-KID-2 SM:KID PI:400
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
154 @RG ID:FLOWCELL2.LANE4 PL:illumina LB:LIB-KID-2 SM:KID PI:400
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
155
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
156 Note the hierarchical relationship between read groups (unique for each lane) to libraries (sequenced on two lanes) and samples (across four lanes, two lanes for each library).
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
157 </token>
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
158 <token name="@info@">
0
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
159 -----
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
160
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
161 .. class:: infomark
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
162
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
163 **More info**
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
164
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
165 To obtain more information about BWA and ask questions use these resources:
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
166
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
167 1. https://biostar.usegalaxy.org/
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
168 2. https://www.biostars.org/
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
169 3. https://github.com/lh3/bwa
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
170 4. http://bio-bwa.sourceforge.net/
2
b4dfb5470bf3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 1
diff changeset
171
8
cbc665adcde4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bwa commit c355891532cecaab6b3288a148a6b3bcb5973396
iuc
parents: 6
diff changeset
172 </token>
0
c9c78719ef26 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
173 </macros>