Mercurial > repos > devteam > bwa

annotate bwa_macros.xml @ 15:4d82cf59895e draft

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-devteam/tree/master/tools/bwa commit dead2eaab58698fe02b8bb068f8d859eba551e8d
author devteam
date Sat, 30 Sep 2017 13:37:06 -0400
parents bd3a1e0de84c
children be4e38d127ae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
1 <macros>
5
fbf460831036 planemo upload commit d0e3412c58bd3bdc1a483a1e2f7f9c2aa5c87a1f-dirty
devteam
parents: 4
diff changeset
2 <import>read_group_macros.xml</import>
11
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
3
15
4d82cf59895e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit dead2eaab58698fe02b8bb068f8d859eba551e8d
devteam
parents: 12
diff changeset
4 <token name="@VERSION@">0.7.16</token>
11
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
5
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
6 <token name="@set_rg_string@">
7
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
7 #set $rg_string = "@RG\\tID:" + str($rg_id)
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
8 #set $rg_string += $format_read_group("\\tSM:", $rg_sm)
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
9 #set $rg_string += $format_read_group("\\tPL:", $rg_pl)
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
10 #set $rg_string += $format_read_group("\\tLB:", $rg_lb)
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
11 #set $rg_string += $format_read_group("\\tCN:", $rg_cn)
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
12 #set $rg_string += $format_read_group("\\tDS:", $rg_ds)
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
13 #set $rg_string += $format_read_group("\\tDT:", $rg_dt)
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
14 #set $rg_string += $format_read_group("\\tFO:", $rg_fo)
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
15 #set $rg_string += $format_read_group("\\tKS:", $rg_ks)
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
16 #set $rg_string += $format_read_group("\\tPG:", $rg_pg)
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
17 #set $rg_string += $format_read_group("\\tPI:", $rg_pi)
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
18 #set $rg_string += $format_read_group("\\tPU:", $rg_pu)
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
19 </token>
6
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
20
11
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
21 <token name="@set_reference_fasta_filename@"><![CDATA[
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
22 #if str( $reference_source.reference_source_selector ) == "history":
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
23 #set $reference_fasta_filename = "localref.fa"
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
24 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" &&
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
25 bwa index
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
26 #if str($reference_source.index_a) != 'auto'
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
27 -a ${reference_source.index_a}
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
28 #end if
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
29 "${reference_fasta_filename}" &&
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
30 #else:
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
31 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
32 #end if
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
33 ]]></token>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
34
7
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
35 <xml name="requirements">
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
36 <requirements>
11
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
37 <requirement type="package" version="@VERSION@">bwa</requirement>
15
4d82cf59895e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit dead2eaab58698fe02b8bb068f8d859eba551e8d
devteam
parents: 12
diff changeset
38 <requirement type="package" version="1.5">samtools</requirement>
7
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
39 </requirements>
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
40 </xml>
d8c9597bfb09 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit ddb8bdb9d62399f086b06b3469450d0aad2113bd
devteam
parents: 6
diff changeset
41
6
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
42 <xml name="stdio">
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
43 <stdio>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
44 <exit_code range="1:" />
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
45 <exit_code range=":-1" />
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
46 <regex match="Error:" />
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
47 <regex match="Exception:" />
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
48 </stdio>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
49 </xml>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
50
11
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
51 <macro name="reference_source_conditional">
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
52 <conditional name="reference_source">
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
53 <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">
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
54 <option value="cached">Use a built-in genome index</option>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
55 <option value="history">Use a genome from history and build index</option>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
56 </param>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
57 <when value="cached">
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
58 <param name="ref_file" type="select" label="Using reference genome" help="Select genome from the list">
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
59 <options from_data_table="bwa_mem_indexes">
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
60 <filter type="sort_by" column="2" />
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
61 <validator type="no_options" message="No indexes are available" />
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
62 </options>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
63 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
64 </param>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
65 </when>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
66 <when value="history">
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
67 <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" />
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
68 <param name="index_a" type="select" label="Algorithm for constructing the BWT index" help="(-a)">
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
69 <option value="auto">Auto. Let BWA decide the best algorithm to use</option>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
70 <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>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
71 <option value="bwtsw">BWT-SW algorithm. This method works also with big genomes</option>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
72 </param>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
73 </when>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
74 </conditional>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
75 </macro>
546ada4a9f43 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 610045611b00099e0a24183c8cf33aebfa9635cf
devteam
parents: 9
diff changeset
76
6
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
77 <macro name="dbKeyActionsBwa">
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
78 <expand macro="dbKeyActions">
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
79 <option type="from_data_table" name="bwa_indexes" column="1" offset="0">
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
80 <filter type="param_value" column="0" value="#" compare="startswith" keep="False"/>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
81 <filter type="param_value" ref="reference_source.ref_file" column="0"/>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
82 </option>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
83 </expand>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
84 </macro>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
85
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
86 <macro name="dbKeyActionsBwaMem">
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
87 <expand macro="dbKeyActions">
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
88 <option type="from_data_table" name="bwa_mem_indexes" column="1" offset="0">
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
89 <filter type="param_value" column="0" value="#" compare="startswith" keep="False"/>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
90 <filter type="param_value" ref="reference_source.ref_file" column="0"/>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
91 </option>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
92 </expand>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
93 </macro>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
94
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
95 <macro name="dbKeyActions">
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
96 <actions>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
97 <conditional name="reference_source.reference_source_selector">
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
98 <when value="cached">
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
99 <action type="metadata" name="dbkey">
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
100 <yield />
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
101 </action>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
102 </when>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
103 <when value="history">
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
104 <action type="metadata" name="dbkey">
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
105 <option type="from_param" name="reference_source.ref_file" param_attribute="dbkey" />
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
106 </action>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
107 </when>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
108 </conditional>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
109 </actions>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
110 </macro>
09a7281d24c5 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
111
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
112 <token name="@RG@">
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
113 -----
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
114
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
115 .. class:: warningmark
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
116
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
117 **Read Groups are Important!**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
118
4
ac30bfd3e2a8 planemo upload commit a50a3947aebc8a1d11bac39599f4efd8ed9a3bd5
devteam
parents: 2
diff changeset
119 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
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
120 **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.
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
121 This allows you to combine BAM files from, for example, multiple BWA runs into a single dataset. This significantly simplifies downstream processing as
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
122 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
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
123 data from different experiments even if they are combined in one file. Many downstream analysis tools such as varinat callers (e.g., FreeBayes or Naive Varinat Caller
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
124 present in Galaxy) are aware of readgtroups and will automatically generate calls for each individual sample even if they are combined within a single file.
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
125
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
126 **Description of read groups fields**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
127
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
128 (from GATK FAQ webpage):
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
129
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
130 .. csv-table::
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
131 :header-rows: 1
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
132
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
133 Tag,Importance,Definition,Meaning
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
134 "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."
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
135 "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)."
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
136 "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."
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
137 "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."
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
138
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
139
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
140 **Example of Read Group usage**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
141
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
142 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::
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
143
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
144 Dad's data:
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
145 @RG ID:FLOWCELL1.LANE1 PL:illumina LB:LIB-DAD-1 SM:DAD PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
146 @RG ID:FLOWCELL1.LANE2 PL:illumina LB:LIB-DAD-1 SM:DAD PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
147 @RG ID:FLOWCELL1.LANE3 PL:illumina LB:LIB-DAD-2 SM:DAD PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
148 @RG ID:FLOWCELL1.LANE4 PL:illumina LB:LIB-DAD-2 SM:DAD PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
149
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
150 Mom's data:
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
151 @RG ID:FLOWCELL1.LANE5 PL:illumina LB:LIB-MOM-1 SM:MOM PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
152 @RG ID:FLOWCELL1.LANE6 PL:illumina LB:LIB-MOM-1 SM:MOM PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
153 @RG ID:FLOWCELL1.LANE7 PL:illumina LB:LIB-MOM-2 SM:MOM PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
154 @RG ID:FLOWCELL1.LANE8 PL:illumina LB:LIB-MOM-2 SM:MOM PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
155
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
156 Kid's data:
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
157 @RG ID:FLOWCELL2.LANE1 PL:illumina LB:LIB-KID-1 SM:KID PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
158 @RG ID:FLOWCELL2.LANE2 PL:illumina LB:LIB-KID-1 SM:KID PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
159 @RG ID:FLOWCELL2.LANE3 PL:illumina LB:LIB-KID-2 SM:KID PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
160 @RG ID:FLOWCELL2.LANE4 PL:illumina LB:LIB-KID-2 SM:KID PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
161
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
162 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).
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
163 </token>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
164 <token name="@info@">
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
165 -----
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
166
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
167 .. class:: infomark
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
168
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
169 **More info**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
170
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
171 To obtain more information about BWA and ask questions use these resources:
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
172
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
173 1. https://biostar.usegalaxy.org/
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
174 2. https://www.biostars.org/
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
175 3. https://github.com/lh3/bwa
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
176 4. http://bio-bwa.sourceforge.net/
12
bd3a1e0de84c planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 11
diff changeset
177
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
178 </token>
12
bd3a1e0de84c planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bwa commit 13b3ab10ff1a2e4be39b44f885df6bbe7c23099a
devteam
parents: 11
diff changeset
179
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
180 <token name="@dataset_collections@">
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
181 ------
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
182
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
183 **Dataset collections - processing large numbers of datasets at once**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
184
4
ac30bfd3e2a8 planemo upload commit a50a3947aebc8a1d11bac39599f4efd8ed9a3bd5
devteam
parents: 2
diff changeset
185 Dataset collections are in beta-testing. Extensive documentation will be added later this Spring.
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
186
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
187
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
188 </token>
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
189
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
190 </macros>