annotate SNV/snvmix.xml @ 0:74f5ea818cea

Uploaded
author ryanmorin
date Wed, 12 Oct 2011 19:50:38 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
1 <tool id="snvmix" name="SNVMix" version="0.12.1-rc1">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
2 <requirements>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
3 <requirement type="package">SNVMix</requirement>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
4 </requirements>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
5 <description>performs SNV calling on a bam file</description>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
6 <command interpreter="python">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
7 snvmix.py
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
8 -i $input1
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
9 -d ${input1.metadata.dbkey}
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
10 -o $output_snvmix
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
11 -t $type
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
12 #if $positionFile == "yes":
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
13 -l $pos
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
14 #else:
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
15 -l 'none'
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
16 #end if
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
17 -x ${GALAXY_DATA_INDEX_DIR}
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
18 -q $q
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
19 -Q $Q
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
20 -f $full
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
21 -R $keep_dups
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
22 -c $keep_chastity
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
23 </command>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
24 <inputs>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
25 <param name="type" type="select" label="model used">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
26 <option value="MB">Filter on map quality AND base quality (MB)</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
27 <option value="SNVMix1">SNVMix1</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
28 <option value="mb">Lowest between map and base quality is used (mb)</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
29 <option value="m">Filter on map quality and use as a surrogate for base quality (m)</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
30 <option value="b">Filter on base quality and set map quality to 1 (b)</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
31 <option value="Mb">Filter on map quality and use both map and base qualities (Mb)</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
32 </param>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
33 <conditional name="refOrHistory">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
34 <param name="reference" type="select" label="Will you select a reference genome from your history or use a built-in index?">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
35 <option value="indexed">Use a built-in index</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
36 <option value="history">Use one from the history</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
37 </param>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
38 <when value="indexed">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
39 <param name="input1" type="data" format="bam" label="Select the BAM file to generate the pileup file for">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
40 <validator type="unspecified_build" />
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
41 <validator type="dataset_metadata_in_file" filename="sam_fa_indices.loc" metadata_name="dbkey" metadata_column="1" message="Sequences are not currently available for the specified build." line_startswith="index" />
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
42 </param>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
43 </when>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
44 <when value="history">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
45 <param name="input1" type="data" format="bam" label="Select the BAM file to generate the pileup file for" />
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
46 <param name="ownFile" type="data" format="fasta" metadata_name="dbkey" label="Select a reference genome" />
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
47 </when>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
48 </conditional>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
49 <param name="q" type="integer" value="19" label="Cutoff Phred value for Base Quality, anything less than or equal to this value is ignored" />
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
50 <param name="Q" type="integer" value="19" label="Cutoff Phred value for Map Quality, anything less than or equal to this value is ignored" />
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
51 <conditional name="positionFile">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
52 <param name="positions" type="select" label="Will you provide a set of positions for SNV calling?">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
53 <option value="no">No, call variants at every position</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
54 <option value="yes">Yes, select one from the history</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
55 </param>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
56 <when value="yes">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
57 <param name="pos" type="data" format="tabular" label="select the tab-delimited file containing positions">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
58 </param>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
59 </when>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
60 </conditional>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
61 <param name="full" type="select" label="Do you want SNVMix to calculate probabilities for each of these positions? (only works in conjunction with above option)">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
62 <option value="no">No, I just want possible variants output</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
63 <option value="yes">Yes (I know this could generate a huge file)</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
64 </param>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
65 <param name="keep_dups" type="select" label="Do you want SNVMix to include reads flagged as duplicates? (only works if Picard or some other tool has set this bit in your bam file">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
66 <option value="no">No (ignore duplicates for variant calling)</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
67 <option value="yes">Yes (use all reads)</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
68 </param>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
69 <param name="keep_chastity" type="select" label="Do you want SNVMix to include reads flagged as failing the chastity filter? (only works if Picard or some other tool has set this bit in your bam file">
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
70 <option value="no">No (ignore filtered reads for variant calling)</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
71 <option value="yes">Yes (use all reads)</option>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
72 </param>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
73 </inputs>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
74
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
75 <outputs>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
76 <data format="tabular" name="output_snvmix" label="${tool.name}: Raw SNVMix calls" />
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
77 </outputs>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
78 <help>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
79
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
80 **What it does**
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
81
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
82 This tool uses the SNVMix model (Goya et al) to call single nucleotide variants (SNVs) from a bam file. The various models described in the study are provided (e.g. SNVMix1, MB, Mb etc.). The most commonly-used models are MB (the default) and SNVMix1. The former thresholds on base quality and mapping quality and uses both qualities in the variant prediction while the latter filters on both and only uses the allele counts in the model. The output is a tab-delimited file that should be passed through the accompanying filtering script prior to use.
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
83
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
84 </help>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
85 </tool>