annotate bwameth.xml @ 17:b55c12d26066 draft

Uploaded
author dpryan79
date Wed, 14 Sep 2016 07:25:39 -0400
parents 66a8223839c8
children 352e0213806c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14
298710673d98 Uploaded
dpryan79
parents:
diff changeset
1 <tool id="bwameth" name="bwameth" version="0.20">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
2 <description>Fast and accurate aligner of BS-Seq reads.</description>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
3 <requirements>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
4 <requirement type="package" version="0.4.6">toolshed</requirement>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
5 <requirement type="package" version="1.2">samtools</requirement>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
6 <requirement type="package" version="0.7.12">bwa</requirement>
17
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
7 <requirement type="package" version="0.20">bwameth</requirement>
14
298710673d98 Uploaded
dpryan79
parents:
diff changeset
8 </requirements>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
9 <stdio>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
10 <exit_code range="1:" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
11 <exit_code range=":-1" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
12 <regex match="Error:" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
13 <regex match="Exception:" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
14 <regex match="Exception :" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
15 </stdio>
17
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
16 <version_command>bwameth.py --version</version_command>
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
17 <command>
14
298710673d98 Uploaded
dpryan79
parents:
diff changeset
18 <![CDATA[
298710673d98 Uploaded
dpryan79
parents:
diff changeset
19 #if $referenceSource.source != "indexed":
17
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
20 mkdir index_dir &&
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
21 ln -s '$referenceSource.reference' index_dir/genome.fa &&
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
22 bwameth.py index index_dir/genome.fa &&
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
23 #set index="index_dir/genome.fa"
14
298710673d98 Uploaded
dpryan79
parents:
diff changeset
24 #else
17
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
25 #set index=$referenceSource.index.fields.path
14
298710673d98 Uploaded
dpryan79
parents:
diff changeset
26 #end if
298710673d98 Uploaded
dpryan79
parents:
diff changeset
27
17
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
28 bwameth.py
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
29 -t "\${GALAXY_SLOTS:-4}"
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
30 --reference ${index}
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
31
14
298710673d98 Uploaded
dpryan79
parents:
diff changeset
32 #if str($readGroup).strip() != "":
17
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
33 --read-group "${readGroup}"
14
298710673d98 Uploaded
dpryan79
parents:
diff changeset
34 #end if
298710673d98 Uploaded
dpryan79
parents:
diff changeset
35
298710673d98 Uploaded
dpryan79
parents:
diff changeset
36 #if $single_or_paired.single_or_paired_opts == 'single':
298710673d98 Uploaded
dpryan79
parents:
diff changeset
37 $single_or_paired.input_singles
298710673d98 Uploaded
dpryan79
parents:
diff changeset
38 #else:
298710673d98 Uploaded
dpryan79
parents:
diff changeset
39 $single_or_paired.input_mate1 $single_or_paired.input_mate2
298710673d98 Uploaded
dpryan79
parents:
diff changeset
40 #end if
17
b55c12d26066 Uploaded
dpryan79
parents: 15
diff changeset
41 | samtools view -u - | samtools sort -@ "\${GALAXY_SLOTS:-4}" output
14
298710673d98 Uploaded
dpryan79
parents:
diff changeset
42 ]]>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
43 </command>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
44 <inputs>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
45 <conditional name="referenceSource">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
46 <param name="source" type="select" label="Select a genome reference from your history or a built-in index?">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
47 <option value="history" selected="True">Use one from the history</option>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
48 <option value="indexed">Use a built-in index</option>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
49 </param>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
50 <when value="history">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
51 <param name="reference" type="data" format="fasta" metadata_name="dbkey" label="Select a genome" help="in FASTA format" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
52 </when>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
53 <when value="indexed">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
54 <param name="index" type="select" label="Select a reference genome" help="If your genome of interest is not listed, contact your Galaxy admin">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
55 <options from_data_table="bwameth_indexes">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
56 <filter type="sort_by" column="2"/>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
57 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
58 </options>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
59 </param>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
60 </when>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
61 </conditional>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
62
298710673d98 Uploaded
dpryan79
parents:
diff changeset
63 <conditional name="single_or_paired">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
64 <param name="single_or_paired_opts" type="select" label="Is this library mate-paired?">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
65 <option value="single">Single-end</option>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
66 <option value="paired">Paired-end</option>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
67 </param>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
68 <when value="single">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
69 <param name="input_singles" type="data" format="fastq" label="FASTQ" help="FASTQ file." />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
70 </when>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
71 <when value="paired">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
72 <param name="input_mate1" type="data" format="fastq" label="First read in pair" help="FASTQ file." />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
73 <param name="input_mate2" type="data" format="fastq" label="Second read in pair" help="FASTQ file." />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
74 </when>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
75 </conditional>
15
66a8223839c8 Uploaded
dpryan79
parents: 14
diff changeset
76 <param name="readGroup" type="text" value="" label="Read group" help="If desired, you can manually add read group information to the resulting BAM file. To do so, you MUST manually specify the entire string, such as '@RG\tID:foo\tSM:bar'">
66a8223839c8 Uploaded
dpryan79
parents: 14
diff changeset
77 <sanitizer sanitize="False"/>
66a8223839c8 Uploaded
dpryan79
parents: 14
diff changeset
78 </param>
14
298710673d98 Uploaded
dpryan79
parents:
diff changeset
79 </inputs>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
80 <outputs>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
81 <data name="output" format="bam" from_work_dir="output.bam" label="${tool.name} on ${on_string}" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
82 </outputs>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
83 <tests>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
84 <test>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
85 <param name="referenceSource" value="history" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
86 <param name="reference" value="ref.fa" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
87 <param name="single_or_paired_opts" value="paired" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
88 <param name="input_mate1" value="t_R1.fastq.gz" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
89 <param name="input_mate2" value="t_R2.fastq.gz" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
90 <output file="output.bam" ftype="bam" name="output" compare="sim_size" delta="10000"/>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
91 </test>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
92 </tests>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
93 <help>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
94 <![CDATA[
298710673d98 Uploaded
dpryan79
parents:
diff changeset
95
298710673d98 Uploaded
dpryan79
parents:
diff changeset
96 **What it does**
298710673d98 Uploaded
dpryan79
parents:
diff changeset
97
298710673d98 Uploaded
dpryan79
parents:
diff changeset
98 BWA-meth performs alignment of reads in a bisulfite-sequencing experiment (e.g., RRBS or WGBS) to a genome. The methodology employed for this is similar to bismark, where both the reads and the reference genome are *in silico* converted prior to alignment. Methylation extraction on the resulting BAM file can be done with the PileOMeth tool.
298710673d98 Uploaded
dpryan79
parents:
diff changeset
99 ]]>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
100 </help>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
101 </tool>