annotate macros.xml @ 0:419ea5baf5b7 draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
author dfornika
date Tue, 28 Jan 2020 01:18:59 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
1 <macros>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
2 <import>read_group_macros.xml</import>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
3
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
4 <token name="@VERSION@">0.7.17</token>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
5
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
6 <token name="@pipefail@"><![CDATA[set -o | grep -q pipefail && set -o pipefail;]]></token>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
7
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
8 <token name="@set_rg_string@">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
9 #set $rg_string = "@RG\\tID:" + str($rg_id)
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
10 #set $rg_string += $format_read_group("\\tSM:", $rg_sm)
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
11 #set $rg_string += $format_read_group("\\tPL:", $rg_pl)
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
12 #set $rg_string += $format_read_group("\\tLB:", $rg_lb)
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
13 #set $rg_string += $format_read_group("\\tCN:", $rg_cn)
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
14 #set $rg_string += $format_read_group("\\tDS:", $rg_ds)
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
15 #set $rg_string += $format_read_group("\\tDT:", $rg_dt)
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
16 #set $rg_string += $format_read_group("\\tFO:", $rg_fo)
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
17 #set $rg_string += $format_read_group("\\tKS:", $rg_ks)
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
18 #set $rg_string += $format_read_group("\\tPG:", $rg_pg)
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
19 #set $rg_string += $format_read_group("\\tPI:", $rg_pi)
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
20 #set $rg_string += $format_read_group("\\tPU:", $rg_pu)
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
21 </token>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
22
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
23 <token name="@set_reference_fasta_filename@"><![CDATA[
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
24 #if str( $reference_source.reference_source_selector ) == "history":
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
25 #set $reference_fasta_filename = "localref.fa"
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
26 ln -s '${reference_source.ref_file}' '${reference_fasta_filename}' &&
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
27 bwa index
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
28 #if str($reference_source.index_a) != 'auto'
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
29 -a ${reference_source.index_a}
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
30 #end if
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
31 '${reference_fasta_filename}' &&
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
32 #else:
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
33 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
34 #end if
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
35 ]]></token>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
36
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
37 <xml name="requirements">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
38 <requirements>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
39 <requirement type="package" version="@VERSION@">bwa</requirement>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
40 <requirement type="package" version="1.6">samtools</requirement>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
41 </requirements>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
42 </xml>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
43
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
44 <xml name="stdio">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
45 <stdio>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
46 <exit_code range="1:" />
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
47 <exit_code range=":-1" />
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
48 <regex match="Error:" />
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
49 <regex match="Exception:" />
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
50 <regex match="\[bns_restore_core\] Parse error reading" />
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
51 </stdio>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
52 </xml>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
53
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
54 <macro name="reference_source_conditional">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
55 <conditional name="reference_source">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
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">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
57 <option value="cached">Use a built-in genome index</option>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
58 <option value="history">Use a genome from history and build index</option>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
59 </param>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
60 <when value="cached">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
61 <param name="ref_file" type="select" label="Using reference genome" help="Select genome from the list">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
62 <options from_data_table="bwa_mem_indexes">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
63 <filter type="sort_by" column="2" />
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
64 <validator type="no_options" message="No indexes are available" />
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
65 </options>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
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"/>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
67 </param>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
68 </when>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
69 <when value="history">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
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" />
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
71 <param name="index_a" type="select" label="Algorithm for constructing the BWT index" help="(-a)">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
72 <option value="auto">Auto. Let BWA decide the best algorithm to use</option>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
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>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
74 <option value="bwtsw">BWT-SW algorithm. This method works also with big genomes</option>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
75 </param>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
76 </when>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
77 </conditional>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
78 </macro>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
79
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
80 <macro name="dbKeyActionsBwaMem">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
81 <expand macro="dbKeyActions">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
82 <option type="from_data_table" name="bwa_mem_indexes" column="1" offset="0">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
83 <filter type="param_value" column="0" value="#" compare="startswith" keep="False"/>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
84 <filter type="param_value" ref="reference_source.ref_file" column="0"/>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
85 </option>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
86 </expand>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
87 </macro>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
88
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
89 <macro name="dbKeyActions">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
90 <actions>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
91 <conditional name="reference_source.reference_source_selector">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
92 <when value="cached">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
93 <action type="metadata" name="dbkey">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
94 <yield />
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
95 </action>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
96 </when>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
97 <when value="history">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
98 <action type="metadata" name="dbkey">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
99 <option type="from_param" name="reference_source.ref_file" param_attribute="dbkey" />
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
100 </action>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
101 </when>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
102 </conditional>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
103 </actions>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
104 </macro>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
105
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
106 <token name="@RG@">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
107 -----
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
108
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
109 .. class:: warningmark
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
110
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
111 **Read Groups are Important!**
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
112
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
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
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
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.
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
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
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
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
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
117 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
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
118 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.
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
119
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
120 **Description of read groups fields**
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
121
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
122 (from GATK FAQ webpage):
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
123
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
124 .. csv-table::
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
125 :header-rows: 1
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
126
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
127 Tag,Importance,Definition,Meaning
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
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."
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
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)."
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
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."
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
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."
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
132
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
133
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
134 **Example of Read Group usage**
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
135
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
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::
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
137
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
138 Dad's data:
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
139 @RG ID:FLOWCELL1.LANE1 PL:illumina LB:LIB-DAD-1 SM:DAD PI:200
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
140 @RG ID:FLOWCELL1.LANE2 PL:illumina LB:LIB-DAD-1 SM:DAD PI:200
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
141 @RG ID:FLOWCELL1.LANE3 PL:illumina LB:LIB-DAD-2 SM:DAD PI:400
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
142 @RG ID:FLOWCELL1.LANE4 PL:illumina LB:LIB-DAD-2 SM:DAD PI:400
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
143
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
144 Mom's data:
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
145 @RG ID:FLOWCELL1.LANE5 PL:illumina LB:LIB-MOM-1 SM:MOM PI:200
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
146 @RG ID:FLOWCELL1.LANE6 PL:illumina LB:LIB-MOM-1 SM:MOM PI:200
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
147 @RG ID:FLOWCELL1.LANE7 PL:illumina LB:LIB-MOM-2 SM:MOM PI:400
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
148 @RG ID:FLOWCELL1.LANE8 PL:illumina LB:LIB-MOM-2 SM:MOM PI:400
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
149
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
150 Kid's data:
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
151 @RG ID:FLOWCELL2.LANE1 PL:illumina LB:LIB-KID-1 SM:KID PI:200
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
152 @RG ID:FLOWCELL2.LANE2 PL:illumina LB:LIB-KID-1 SM:KID PI:200
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
153 @RG ID:FLOWCELL2.LANE3 PL:illumina LB:LIB-KID-2 SM:KID PI:400
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
154 @RG ID:FLOWCELL2.LANE4 PL:illumina LB:LIB-KID-2 SM:KID PI:400
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
155
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
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).
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
157 </token>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
158 <token name="@info@">
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
159 -----
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
160
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
161 .. class:: infomark
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
162
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
163 **More info**
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
164
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
165 To obtain more information about BWA and ask questions use these resources:
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
166
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
167 1. https://biostar.usegalaxy.org/
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
168 2. https://www.biostars.org/
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
169 3. https://github.com/lh3/bwa
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
170 4. http://bio-bwa.sourceforge.net/
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
171
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
172 </token>
419ea5baf5b7 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mashtree commit 9b894593cf3c0156faf679300ded731e0796f792"
dfornika
parents:
diff changeset
173 </macros>