View source for SplitPed

This page documents the splitPed program, which splits a pedigree file into smaller files with subsets of markers.

== Input Files ==
=== Required Input Files ===
==== Pedigree file (.ped) ====
File fed to -ped option, in [[Merlin]] format pedigree file. For details of the Merlin file format, see the Merlin tutorial [http://csg.sph.umich.edu//abecasis/Merlin/tour/input_files.html]. <br>
Within each file, markers should be stored by chromosome position. Alleles should be stored in the forward strand and can be encoded as 'A', 'C', 'G' or 'T' (there is no need to use numeric identifiers for each allele). <br>

==== Marker information (.dat) file ====
File fed to -dat option, in [[Merlin]] format marker information file. For details of the Merlin file format, see the Merlin tutorial [http://csg.sph.umich.edu//abecasis/Merlin/tour/input_files.html]. <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 ===
==== Split original pedigree file? ====
This is controlled by -splitPed option. By default, all the output marker information (.dat) files share the same input pedigree (.ped) file and NO output pedigree (.ped) file is generated. <br>
If one wants separate .ped and .dat files for each output window, use "-splitPed 1". <br>

==== 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 ==
  splitPed.pl -ped example.ped -dat example.dat -map example.map -windowLength 10000000 -overlapLength 1000000 -o split
  splitPed.pl -ped example.ped -dat example.dat -map example.map -windowLength 10000000 -overlapLength 1000000 -splitPed 1 -o split.with_ped
  splitPed.pl -ped example.ped -dat example.dat -windowSize 10000 -overlapSize 1000 -o split
  splitPed.pl -ped example.ped -dat example.dat -nWindows 12 -overlapSize 1000 -o split

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

== Questions and Comments?  ==

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