annotate samtools_phase.xml @ 0:cba1944e3ed0 draft

Uploaded tool and dependency definition.
author devteam
date Thu, 27 Mar 2014 15:26:17 -0400
parents
children 8bfe0d1616d2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
1 <tool id="samtools_phase" name="Call and phase" version="1.0.0">
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
2 <description>heterozygous SNPs</description>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
3 <requirements>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
4 <requirement type="package" version="0.1.19">samtools</requirement>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
5 </requirements>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
6 <command>samtools phase -b "phase_wrapper"
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
7 #if str($option_set.option_sets) == 'advanced':
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
8 ${option_set.ignore_chimeras}
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
9 -k $option_set.block_length
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
10 -q $option_set.min_het
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
11 -Q $option_set.min_bq
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
12 -D $option_set.read_depth
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
13 ${option_set.drop_ambiguous}
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
14 #else
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
15 -k 13 -q 37 -Q 13 -D 256
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
16 #end if
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
17 "$input_bam" &gt; "$phase_sets"
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
18 </command>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
19 <stdio>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
20 <exit_code range="1:" level="fatal" description="Error" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
21 </stdio>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
22 <inputs>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
23 <param format="bam" name="input_bam" type="data" label="Select dataset to phase"/>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
24 <conditional name="option_set">
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
25 <param name="option_sets" type="select" label="Phase parameters">
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
26 <option value="default">Use defaults</option>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
27 <option value="advanced">Advanced options</option>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
28 </param>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
29 <when value="default" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
30 <when value="advanced">
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
31 <param name="block_length" type="integer" value="13" label="Maximum length for local phasing" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
32 <param name="min_het" type="integer" value="37" label="Minimum Phred-scaled level of detail to call a heterozygote" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
33 <param name="min_bq" type="integer" value="13" label="Minimum base quality to be used in het calling" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
34 <param name="read_depth" type="integer" value="256" label="Read depth" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
35 <param name="ignore_chimeras" type="boolean" truevalue="-F" falsevalue="" checked="False" label="Do not attempt to fix chimeric reads" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
36 <param name="drop_ambiguous" type="boolean" truevalue="-A 1" falsevalue="" checked="False" label="Drop reads with ambiguous phase" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
37 </when>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
38 </conditional>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
39 </inputs>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
40 <outputs>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
41 <data format="txt" name="phase_sets" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
42 <data format="bam" from_work_dir="phase_wrapper.0.bam" name="phase0" label="${tool.name} on ${on_string}: Phase-0 reads" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
43 <data format="bam" from_work_dir="phase_wrapper.1.bam" name="phase1" label="${tool.name} on ${on_string}: Phase-1 reads" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
44 <data format="bam" from_work_dir="phase_wrapper.chimeras.bam" name="chimera" label="${tool.name} on ${on_string}: Chimeric reads" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
45 </outputs>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
46 <tests>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
47 <test>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
48 <param name="option_sets" value="default" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
49 <param name="input_bam" value="samtools_phase_in_1.bam" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
50 <output name="phase_sets" file="samtools_phase_out_1_log.txt" ftype="txt" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
51 <output name="phase0" file="samtools_phase_out_1_phase0.bam" ftype="bam" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
52 <output name="phase1" file="samtools_phase_out_1_phase1.bam" ftype="bam" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
53 <output name="chimera" file="empty_file.bam" compare="contains" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
54 </test>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
55 <test>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
56 <param name="input_bam" value="samtools_phase_in_2.bam" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
57 <param name="option_sets" value="advanced" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
58 <param name="option_set|block_length" value="13" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
59 <param name="option_set|min_het" value="37" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
60 <param name="option_set|min_bq" value="13" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
61 <param name="option_set|read_depth" value="256" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
62 <param name="option_set|ignore_chimeras" value="false" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
63 <param name="option_set|drop_ambiguous" value="true" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
64 <output name="phase_sets" file="samtools_phase_out_2_log.txt" ftype="txt" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
65 <output name="phase0" file="samtools_phase_out_2_phase0.bam" ftype="bam" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
66 <output name="phase1" file="samtools_phase_out_2_phase1.bam" ftype="bam" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
67 <output name="chimera" file="empty_file.bam" compare="contains" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
68 </test>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
69 <test>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
70 <param name="input_bam" value="samtools_phase_in_2.bam" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
71 <param name="option_sets" value="advanced" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
72 <param name="option_set|block_length" value="13" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
73 <param name="option_set|min_het" value="37" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
74 <param name="option_set|min_bq" value="13" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
75 <param name="option_set|read_depth" value="256" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
76 <param name="option_set|ignore_chimeras" value="true" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
77 <param name="option_set|drop_ambiguous" value="false" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
78 <output name="phase_sets" file="samtools_phase_out_3_log.txt" ftype="txt" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
79 <output name="phase0" file="samtools_phase_out_3_phase0.bam" ftype="bam" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
80 <output name="phase1" file="samtools_phase_out_3_phase1.bam" ftype="bam" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
81 <output name="chimera" file="empty_file.bam" compare="contains" />
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
82 </test>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
83 </tests>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
84 <help>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
85 **What it does**
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
86
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
87 Call and phase heterozygous SNPs
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
88
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
89 ------
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
90
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
91 .. list-table:: **Options**
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
92 :widths: 5 5 40 10
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
93 :header-rows: 1
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
94
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
95 * - Flag
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
96 - Type
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
97 - Description
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
98 - Default
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
99 * - -k
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
100 - INT
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
101 - Block length
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
102 - 13
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
103 * - -b
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
104 - STR
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
105 - Prefix of BAM file output
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
106 - *null*
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
107 * - -q
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
108 - INT
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
109 - Minimum het phred-LOD
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
110 - 37
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
111 * - -Q
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
112 - INT
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
113 - Min base quality in het calling
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
114 - 13
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
115 * - -D
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
116 - INT
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
117 - Max read depth
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
118 - 256
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
119 * - -D
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
120 - BOOLEAN
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
121 - Do not attempt to fix chimeras
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
122 - *off*
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
123 * - -A
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
124 - BOOLEAN
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
125 - Drop reads with ambiguous phase
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
126 - *off*
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
127
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
128 ------
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
129
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
130 **Citation**
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
131
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
132 For the underlying tool, please cite `Li H, Handsaker B, Wysoker A, Fennell T, Ruan J, Homer N, Marth G, Abecasis G, Durbin R; 1000 Genome Project Data Processing Subgroup. The Sequence Alignment/Map format and SAMtools. Bioinformatics. 2009 Aug 15;25(16):2078-9. &lt;http://www.ncbi.nlm.nih.gov/pubmed/19505943&gt;`_
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
133
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
134
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
135 If you use this tool in Galaxy, please cite Blankenberg D, et al. *In preparation.*
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
136
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
137 </help>
cba1944e3ed0 Uploaded tool and dependency definition.
devteam
parents:
diff changeset
138 </tool>