# HG changeset patch
# User gregory-minevich
# Date 1332254415 14400
# Node ID 619b943864a9c629c128df742499e28b2c2f77f4
# Parent  30fa4d84e84c574d6a6dfd07eeada5bdf9961419
Uploaded

diff -r 30fa4d84e84c -r 619b943864a9 ._SNP_Mapping.py
Binary file ._SNP_Mapping.py has changed
diff -r 30fa4d84e84c -r 619b943864a9 ._SNP_Mapping.xml
Binary file ._SNP_Mapping.xml has changed
diff -r 30fa4d84e84c -r 619b943864a9 SNP_Mapping.xml
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/SNP_Mapping.xml	Tue Mar 20 10:40:15 2012 -0400
@@ -0,0 +1,109 @@
+<tool id="SNP_Mapping" name="SNP Mapping">
+    <description>Map a mutation by plotting recombination frequencies resulting from crossing to a highly polymorphic strain</description>
+    <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>
+    <inputs>
+        <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" />
+	<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"/>
+	<param name="loess_span" size = "15" type="float" value=".01" label="Loess span" help="Parameter that controls the degree of data smoothing."/>    
+	<param name="d_yaxis" size = "15" type="float" value=".7" label="Y-axis upper limit for dot plot" />
+	<param name="h_yaxis" size = "15" type="integer" value="500" label="Y-axis upper limit for histogram plot" />
+	<param name="points_color" size = "15" type="text" value="gray27" label="Color for data points" help="See below for list of supported colors"/> 
+	<param name="loess_color" size = "15" type="text" value="red" label="Color for loess regression line" help="See below for list of supported colors"/>
+	<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"/>          
+    </inputs>
+    <outputs>
+        <data name="output" type="text" format="tabular" />
+	<data name="location_plot_output" format="pdf" />
+    </outputs>
+    <requirements>
+        <requirement type="python-module">sys</requirement>
+        <requirement type="python-module">optparse</requirement>
+        <requirement type="python-module">csv</requirement>
+        <requirement type="python-module">re</requirement>
+	<requirement type="python-module">decimal</requirement>
+        <requirement type="python-module">rpy</requirement>
+    </requirements>
+    <tests>
+	<param name="sample_pileup" value="" />
+	<param name="haw_vcf" value="" />
+	<output name="output" file="" />
+	<output name="plot_output" file="" />
+    </tests>
+    <help>
+**What it does:** 
+
+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:
+
+.. image:: http://biochemistry.hs.columbia.edu/labs/hobert/CloudMap/SNP_Mapping_Linked_LG.pdf
+
+
+
+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. 
+
+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.
+
+
+The experimental design required to generate data for the plots is described in Doisidou et al., PLoS One 2010 Figure 1:
+
+.. image:: http://biochemistry.hs.columbia.edu/labs/hobert/CloudMap/Doitsidou_2010_PLoS_Fig1.pdf
+
+
+------
+
+**Input:** 
+
+
+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.  
+
+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:
+http://biochemistry.hs.columbia.edu/labs/hobert/protocols.html
+
+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.
+(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.
+
+
+**Output:**
+
+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.  
+
+
+------
+
+**Settings:**
+
+.. class:: infomark
+
+Information on loess regression and the loess span parameter:
+http://en.wikipedia.org/wiki/Local_regression
+
+.. class:: infomark
+
+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.
+
+.. class:: infomark
+
+Supported colors for data points and loess regression line:
+
+http://www.stat.columbia.edu/~tzheng/files/Rcolor.pdf
+
+http://research.stowers-institute.org/efg/R/Color/Chart/ColorChart.pdf
+
+
+
+.. class:: warningmark
+
+This tool requires that R has been installed on your system (http://www.r-project.org/).
+
+
+------
+
+**Citation:**
+
+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)`__
+
+    .. __: http://biochemistry.hs.columbia.edu/labs/hobert/literature.html
+
+
+
+    </help>
+</tool>