annotate SNP_Mapping.xml @ 1:619b943864a9

Uploaded
author gregory-minevich
date Tue, 20 Mar 2012 10:40:15 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
1 <tool id="SNP_Mapping" name="SNP Mapping">
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
2 <description>Map a mutation by plotting recombination frequencies resulting from crossing to a highly polymorphic strain</description>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
3 <command interpreter="python">SNP_Mapping.py --sample_pileup $sample_pileup --haw_vcf $haw_vcf --loess_span $loess_span --d_yaxis $d_yaxis --h_yaxis $h_yaxis --points_color $points_color --loess_color $loess_color --output $output --location_plot_output $location_plot_output --standardize $standardize</command>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
4 <inputs>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
5 <param name="sample_pileup" size = "125" type="data" format="pileup" label="WGS Mutant Pileup File" help="WGS pileup file from pooled F2 mutants that have been crossed to a mapping strain. The pileup should contain data from only mapping strain (e.g. Hawaiian) SNP positions" />
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
6 <param name="haw_vcf" size = "125" type="data" format="vcf" label="VCF of mapping strain (e.g. Hawaiian) SNPs" help="A VCF reference file that contains mapping strain SNP positions and reference base pairs at each position"/>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
7 <param name="loess_span" size = "15" type="float" value=".01" label="Loess span" help="Parameter that controls the degree of data smoothing."/>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
8 <param name="d_yaxis" size = "15" type="float" value=".7" label="Y-axis upper limit for dot plot" />
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
9 <param name="h_yaxis" size = "15" type="integer" value="500" label="Y-axis upper limit for histogram plot" />
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
10 <param name="points_color" size = "15" type="text" value="gray27" label="Color for data points" help="See below for list of supported colors"/>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
11 <param name="loess_color" size = "15" type="text" value="red" label="Color for loess regression line" help="See below for list of supported colors"/>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
12 <param name="standardize" type="boolean" truevalue="true" falsevalue="false" checked="true" label="Standardize X-axis" help="Dot plots and histogram plots from separate chromosomes will have uniform X-axis spacing for comparison"/>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
13 </inputs>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
14 <outputs>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
15 <data name="output" type="text" format="tabular" />
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
16 <data name="location_plot_output" format="pdf" />
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
17 </outputs>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
18 <requirements>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
19 <requirement type="python-module">sys</requirement>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
20 <requirement type="python-module">optparse</requirement>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
21 <requirement type="python-module">csv</requirement>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
22 <requirement type="python-module">re</requirement>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
23 <requirement type="python-module">decimal</requirement>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
24 <requirement type="python-module">rpy</requirement>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
25 </requirements>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
26 <tests>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
27 <param name="sample_pileup" value="" />
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
28 <param name="haw_vcf" value="" />
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
29 <output name="output" file="" />
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
30 <output name="plot_output" file="" />
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
31 </tests>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
32 <help>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
33 **What it does:**
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
34
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
35 This tool improves upon the method described in Doitsidou et al., PLoS One 2010 for mapping causal mutations using whole genome sequencing data. Sample output for a linked chromosome:
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
36
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
37 .. image:: http://biochemistry.hs.columbia.edu/labs/hobert/CloudMap/SNP_Mapping_Linked_LG.pdf
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
38
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
39
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
40
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
41 The polymorphic Hawaiian strain CB4856 is used as a mapping strain in most cases but in principle any sequenced nematode strain that is significantly different from the mutant strain can be used for mapping. The tool plots the ratio of mutant strain (N2)/mapping strain (Hawaiian) nucleotides, reflecting the number of recombinants in the sequenced pool of animals. Chromosomes which contain regions of linkage to the causal mutation will have regions where the ratio of mapping strain (Hawaiian)/total reads will be equal to 0. The scatter plots for such linked regions will have a high number of data points lying exactly on the X axis. A loess regression line is plotted through all the points on a given chromosome giving further accuracy to the linked region.
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
42
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
43 Each scatter plot has a corresponding frequency plot that displays regions of linked chromosome where 0 ratio SNP positions are concentrated. 1Mb bins for the 0 ratio SNP positions are colored gray by default and .5Mb bins are colored in red.
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
44
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
45
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
46 The experimental design required to generate data for the plots is described in Doisidou et al., PLoS One 2010 Figure 1:
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
47
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
48 .. image:: http://biochemistry.hs.columbia.edu/labs/hobert/CloudMap/Doitsidou_2010_PLoS_Fig1.pdf
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
49
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
50
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
51 ------
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
52
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
53 **Input:**
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
54
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
55
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
56 The input pileup files are generated by the SAMTools mpileup tool. Default SAMTools mpileup (and Samtools filter pileup) parameters for mapping quality, base quality and coverage at each SNP position typically yield good results, though users may experiment with filtering SNP data according to these parameters. In our testing, low threshold filtering on base pair quality has been useful in improving accuracy of plots while high threshold filtering on coverage has skewed plot accuracy.
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
57
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
58 This tool requires a pileup that has been created at each SNP position using SAMTools mpileup and a BED file of all Hawaiian SNP positions. Download Hawaiian SNP positions BED file here:
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
59 http://biochemistry.hs.columbia.edu/labs/hobert/protocols.html
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
60
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
61 The required VCF of mapping strain (e.g. Hawaiian) SNPs is a reference file that contains mapping strain SNP positions and reference base pairs at each position.
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
62 (download Hawaiian SNPs VCF from: http://biochemistry.hs.columbia.edu/labs/hobert/protocols.html). You may also make your own VCF of SNP positions following the steps described in the CloudMAP paper.
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
63
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
64
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
65 **Output:**
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
66
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
67 The tool also provides a tabular output file that contains a count of the number of reference and alternate SNPs at each mapping strain SNP position as well as the ratio of reference/alternate SNPs. The position of each mapping strain SNP in map units and physical coordinates is also provided in the output file.
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
68
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
69
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
70 ------
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
71
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
72 **Settings:**
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
73
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
74 .. class:: infomark
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
75
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
76 Information on loess regression and the loess span parameter:
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
77 http://en.wikipedia.org/wiki/Local_regression
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
78
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
79 .. class:: infomark
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
80
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
81 Based on our testing, we've settled on .01 as a loess span default. Larger values result in smoothing of the line to reflect trends at a more macro level. Smaller values result in loess lines that more closely reflect local data fluctuations. Users looking at chromosome subregions will want to increase the loess span.
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
82
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
83 .. class:: infomark
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
84
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
85 Supported colors for data points and loess regression line:
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
86
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
87 http://www.stat.columbia.edu/~tzheng/files/Rcolor.pdf
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
88
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
89 http://research.stowers-institute.org/efg/R/Color/Chart/ColorChart.pdf
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
90
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
91
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
92
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
93 .. class:: warningmark
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
94
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
95 This tool requires that R has been installed on your system (http://www.r-project.org/).
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
96
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
97
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
98 ------
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
99
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
100 **Citation:**
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
101
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
102 This tool is part of the CloudMap package from the Hobert Lab. If you use this tool, please cite `Gregory Minevich, Danny Park, Richard J. Poole and Oliver Hobert CloudMap: A Cloud-based Pipeline for Analysis of Mutant Genome Sequences. (2012 In Preparation)`__
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
103
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
104 .. __: http://biochemistry.hs.columbia.edu/labs/hobert/literature.html
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
105
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
106
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
107
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
108 </help>
619b943864a9 Uploaded
gregory-minevich
parents:
diff changeset
109 </tool>