annotate samtools_phase.xml @ 3:c21cb56fbbbc draft

planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
author devteam
date Tue, 13 Oct 2015 12:55:05 -0400
parents 2656247b5253
children 2311187710fb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
c21cb56fbbbc planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 2
diff changeset
1 <tool id="samtools_phase" name="Call and phase" version="2.0">
0
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
2 <description>heterozygous SNPs</description>
3
c21cb56fbbbc planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 2
diff changeset
3 <macros>
c21cb56fbbbc planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 2
diff changeset
4 <import>macros.xml</import>
c21cb56fbbbc planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 2
diff changeset
5 </macros>
c21cb56fbbbc planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 2
diff changeset
6 <expand macro="requirements"></expand>
c21cb56fbbbc planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 2
diff changeset
7 <expand macro="stdio"></expand>
c21cb56fbbbc planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 2
diff changeset
8 <expand macro="version_command"></expand>
0
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
9 <command>samtools phase -b "phase_wrapper"
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
10 #if str($option_set.option_sets) == 'advanced':
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
11 ${option_set.ignore_chimeras}
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
12 -k $option_set.block_length
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
13 -q $option_set.min_het
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
14 -Q $option_set.min_bq
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
15 -D $option_set.read_depth
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
16 ${option_set.drop_ambiguous}
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
17 #else
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
18 -k 13 -q 37 -Q 13 -D 256
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
19 #end if
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
20 "$input_bam" &gt; "$phase_sets"
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
21 </command>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
22 <inputs>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
23 <param format="bam" name="input_bam" type="data" label="Select dataset to phase"/>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
24 <conditional name="option_set">
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
25 <param name="option_sets" type="select" label="Phase parameters">
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
26 <option value="default">Use defaults</option>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
27 <option value="advanced">Advanced options</option>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
28 </param>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
29 <when value="default" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
30 <when value="advanced">
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
31 <param name="block_length" type="integer" value="13" label="Maximum length for local phasing" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
32 <param name="min_het" type="integer" value="37" label="Minimum Phred-scaled level of detail to call a heterozygote" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
33 <param name="min_bq" type="integer" value="13" label="Minimum base quality to be used in het calling" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
34 <param name="read_depth" type="integer" value="256" label="Read depth" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
35 <param name="ignore_chimeras" type="boolean" truevalue="-F" falsevalue="" checked="False" label="Do not attempt to fix chimeric reads" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
36 <param name="drop_ambiguous" type="boolean" truevalue="-A 1" falsevalue="" checked="False" label="Drop reads with ambiguous phase" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
37 </when>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
38 </conditional>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
39 </inputs>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
40 <outputs>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
41 <data format="txt" name="phase_sets" />
a0af255e28c1 Imported from capsule None
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" />
a0af255e28c1 Imported from capsule None
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" />
a0af255e28c1 Imported from capsule None
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" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
45 </outputs>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
46 <tests>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
47 <test>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
48 <param name="option_sets" value="default" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
49 <param name="input_bam" value="samtools_phase_in_1.bam" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
50 <output name="phase_sets" file="samtools_phase_out_1_log.txt" ftype="txt" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
51 <output name="phase0" file="samtools_phase_out_1_phase0.bam" ftype="bam" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
52 <output name="phase1" file="samtools_phase_out_1_phase1.bam" ftype="bam" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
53 <output name="chimera" file="empty_file.bam" compare="contains" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
54 </test>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
55 <test>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
56 <param name="input_bam" value="samtools_phase_in_2.bam" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
57 <param name="option_sets" value="advanced" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
58 <param name="option_set|block_length" value="13" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
59 <param name="option_set|min_het" value="37" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
60 <param name="option_set|min_bq" value="13" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
61 <param name="option_set|read_depth" value="256" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
62 <param name="option_set|ignore_chimeras" value="false" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
63 <param name="option_set|drop_ambiguous" value="true" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
64 <output name="phase_sets" file="samtools_phase_out_2_log.txt" ftype="txt" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
65 <output name="phase0" file="samtools_phase_out_2_phase0.bam" ftype="bam" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
66 <output name="phase1" file="samtools_phase_out_2_phase1.bam" ftype="bam" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
67 <output name="chimera" file="empty_file.bam" compare="contains" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
68 </test>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
69 <test>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
70 <param name="input_bam" value="samtools_phase_in_2.bam" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
71 <param name="option_sets" value="advanced" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
72 <param name="option_set|block_length" value="13" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
73 <param name="option_set|min_het" value="37" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
74 <param name="option_set|min_bq" value="13" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
75 <param name="option_set|read_depth" value="256" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
76 <param name="option_set|ignore_chimeras" value="true" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
77 <param name="option_set|drop_ambiguous" value="false" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
78 <output name="phase_sets" file="samtools_phase_out_3_log.txt" ftype="txt" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
79 <output name="phase0" file="samtools_phase_out_3_phase0.bam" ftype="bam" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
80 <output name="phase1" file="samtools_phase_out_3_phase1.bam" ftype="bam" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
81 <output name="chimera" file="empty_file.bam" compare="contains" />
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
82 </test>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
83 </tests>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
84 <help>
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
85 **What it does**
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
86
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
87 Call and phase heterozygous SNPs
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
88
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
89 ------
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
90
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
91 .. list-table:: **Options**
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
92 :widths: 5 5 40 10
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
93 :header-rows: 1
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
94
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
95 * - Flag
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
96 - Type
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
97 - Description
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
98 - Default
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
99 * - -k
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
100 - INT
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
101 - Block length
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
102 - 13
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
103 * - -b
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
104 - STR
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
105 - Prefix of BAM file output
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
106 - *null*
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
107 * - -q
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
108 - INT
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
109 - Minimum het phred-LOD
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
110 - 37
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
111 * - -Q
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
112 - INT
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
113 - Min base quality in het calling
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
114 - 13
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
115 * - -D
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
116 - INT
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
117 - Max read depth
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
118 - 256
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
119 * - -D
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
120 - BOOLEAN
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
121 - Do not attempt to fix chimeras
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
122 - *off*
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
123 * - -A
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
124 - BOOLEAN
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
125 - Drop reads with ambiguous phase
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
126 - *off*
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
127
3
c21cb56fbbbc planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 2
diff changeset
128 </help>
c21cb56fbbbc planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 2
diff changeset
129 <expand macro="citations"></expand>
0
a0af255e28c1 Imported from capsule None
devteam
parents:
diff changeset
130 </tool>