annotate bwameth.xml @ 14:298710673d98 draft

Uploaded
author dpryan79
date Wed, 14 Sep 2016 04:53:59 -0400
parents
children 66a8223839c8
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>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
7 </requirements>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
8 <stdio>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
9 <exit_code range="1:" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
10 <exit_code range=":-1" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
11 <regex match="Error:" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
12 <regex match="Exception:" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
13 <regex match="Exception :" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
14 </stdio>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
15 <command interpreter="python">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
16 <![CDATA[
298710673d98 Uploaded
dpryan79
parents:
diff changeset
17 bwameth_wrapper.py
298710673d98 Uploaded
dpryan79
parents:
diff changeset
18 -p "\${GALAXY_SLOTS:-4}"
298710673d98 Uploaded
dpryan79
parents:
diff changeset
19
298710673d98 Uploaded
dpryan79
parents:
diff changeset
20 #if $referenceSource.source != "indexed":
298710673d98 Uploaded
dpryan79
parents:
diff changeset
21 --makeIndex $referenceSource.reference
298710673d98 Uploaded
dpryan79
parents:
diff changeset
22 #else
298710673d98 Uploaded
dpryan79
parents:
diff changeset
23 --premadeIndex $referenceSource.index.fields.path
298710673d98 Uploaded
dpryan79
parents:
diff changeset
24 #end if
298710673d98 Uploaded
dpryan79
parents:
diff changeset
25
298710673d98 Uploaded
dpryan79
parents:
diff changeset
26 #if str($readGroup).strip() != "":
298710673d98 Uploaded
dpryan79
parents:
diff changeset
27 --readGroup "${readGroup}"
298710673d98 Uploaded
dpryan79
parents:
diff changeset
28 #end if
298710673d98 Uploaded
dpryan79
parents:
diff changeset
29
298710673d98 Uploaded
dpryan79
parents:
diff changeset
30 #if $single_or_paired.single_or_paired_opts == 'single':
298710673d98 Uploaded
dpryan79
parents:
diff changeset
31 $single_or_paired.input_singles
298710673d98 Uploaded
dpryan79
parents:
diff changeset
32 #else:
298710673d98 Uploaded
dpryan79
parents:
diff changeset
33 $single_or_paired.input_mate1 $single_or_paired.input_mate2
298710673d98 Uploaded
dpryan79
parents:
diff changeset
34 #end if
298710673d98 Uploaded
dpryan79
parents:
diff changeset
35 ]]>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
36 </command>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
37 <inputs>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
38 <conditional name="referenceSource">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
39 <param name="source" type="select" label="Select a genome reference from your history or a built-in index?">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
40 <option value="history" selected="True">Use one from the history</option>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
41 <option value="indexed">Use a built-in index</option>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
42 </param>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
43 <when value="history">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
44 <param name="reference" type="data" format="fasta" metadata_name="dbkey" label="Select a genome" help="in FASTA format" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
45 </when>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
46 <when value="indexed">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
47 <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
48 <options from_data_table="bwameth_indexes">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
49 <filter type="sort_by" column="2"/>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
50 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
51 </options>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
52 </param>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
53 </when>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
54 </conditional>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
55
298710673d98 Uploaded
dpryan79
parents:
diff changeset
56 <conditional name="single_or_paired">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
57 <param name="single_or_paired_opts" type="select" label="Is this library mate-paired?">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
58 <option value="single">Single-end</option>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
59 <option value="paired">Paired-end</option>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
60 </param>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
61 <when value="single">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
62 <param name="input_singles" type="data" format="fastq" label="FASTQ" help="FASTQ file." />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
63 </when>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
64 <when value="paired">
298710673d98 Uploaded
dpryan79
parents:
diff changeset
65 <param name="input_mate1" type="data" format="fastq" label="First read in pair" help="FASTQ file." />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
66 <param name="input_mate2" type="data" format="fastq" label="Second read in pair" help="FASTQ file." />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
67 </when>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
68 </conditional>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
69 <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'" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
70 </inputs>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
71 <outputs>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
72 <data name="output" format="bam" from_work_dir="output.bam" label="${tool.name} on ${on_string}" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
73 </outputs>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
74 <tests>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
75 <test>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
76 <param name="referenceSource" value="history" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
77 <param name="reference" value="ref.fa" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
78 <param name="single_or_paired_opts" value="paired" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
79 <param name="input_mate1" value="t_R1.fastq.gz" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
80 <param name="input_mate2" value="t_R2.fastq.gz" />
298710673d98 Uploaded
dpryan79
parents:
diff changeset
81 <output file="output.bam" ftype="bam" name="output" compare="sim_size" delta="10000"/>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
82 </test>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
83 </tests>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
84 <help>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
85 <![CDATA[
298710673d98 Uploaded
dpryan79
parents:
diff changeset
86
298710673d98 Uploaded
dpryan79
parents:
diff changeset
87 **What it does**
298710673d98 Uploaded
dpryan79
parents:
diff changeset
88
298710673d98 Uploaded
dpryan79
parents:
diff changeset
89 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
90 ]]>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
91 </help>
298710673d98 Uploaded
dpryan79
parents:
diff changeset
92 </tool>