View source for SplitRef

This page documents the splitRef program, which splits a reference haplotype file into smaller files with subsets of markers.

== Input Files ==
=== Required Input Files ===
==== Haplotype file (.hap) ====
File fed to -hap option. One line for one haplotype, with last field containing the actual alleles with no separators between alleles. <br>

==== Marker list (.snps) file ====
File fed to -snps option. One line for each marker: marker name only. <br>

=== Optional Input Files ===
==== Map file ====
File fed to -map option, containing chromosome, marker name, and marker coordinate (in base pairs) information for each marker. Markers should be stored in the same order as in the marker information file. <br>

== Options ==
=== Required options ===
==== window size ====
Window size can be specified by one of the following three options: (1) -nWindows (2) -windowSize and (3) -windowLength. <br>
-nWindows specifies the number of windows to split into and the program splits markers evenly into output windows. <br>
-windowSize specifies the number of markers in one output window. The remainder goes to the last window. <br>
-windowLength specifies the length (in base pairs) of one output window. The remainder goes to the last window. Note that this option is only allowed when map input file is specified. <br>

==== flanking region ====
Size of flanking region on each side can be specified by one of the following two options: (1) -overlapSize and (2) -overlapLength. <br>
-overlapSize specifies the number of markers in each flanking region (so that the total number of flanking markers for each window is twice the number specified except for the first and last window). <br>
-overlapLength specifies the length (in base pairs) of each flanking region (so that the total length of the flanking regions is twice the number specified except for the first and last window). <br>

==== Output prefix ====
Specified by -o option. <br>

=== Additional options ===
==== Estimate window size only ====
This is controlled by -extimateWindowOnly option. By default, splitting is performed. <br>
But if one only wishes to peek into how the markers are allocated into output windows, use "-extimateWindowOnly 1". <br>

== Example Commands ==
  splitRef.pl -hap example.hap.gz -snps example.snps -map example.map -windowLength 10000000 -overlapLength 1000000 
  splitRef.pl -hap example.hap.gz -snps example.snps -windowSize 10000 -overlapSize 1000 
  splitRef.pl -hap example.hap.gz -snps example.snps -nWindows 12 -overlapSize 1000 

== Download ==
You can download splitPed at [http://csg.sph.umich.edu//yli/splitRef/download/ splitRef Download Page].

== Questions and Comments?  ==

Email [mailto:yunli@med.unc.edu Yun Li].