readme.txt

   1
   2 GENOME: coalescent-based whole genome simulator
   3 (c) 2006-2009 Liming Liang, Goncalo Abecasis
   4
   5
   6
   7 DISCLAIMER
   8 ==========
   9
  10 This is version of GENOME is provided to you free of charge.  It comes with
  11 no guarantees. If you report bugs and provide helpful comments, the next
  12 version will be better.
  13
  14
  15 DISTRIBUTION
  16 ============
  17
  18 The latest version of GENOME is available at:
  19
  20    http://www.sph.umich.edu/csg/liang/genome
  21
  22 If you use GENOME please register by e-mailing lianglim@umich.edu.
  23
  24 Code for GENOME is subject to specific
  25 license conditions -- please see file LICENSE.GENOME for additional
  26 information.
  27
  28 Code for the Mersenne Twister random number generator is subject to specific
  29 license conditions -- please see file LICENSE.twister for additional
  30 information.
  31
  32
  33
  34
  35 BRIEF INSTRUCTIONS
  36 ==================
  37
  38 A complete manual is available at:
  39
  40      http://www.sph.umich.edu/csg/liang/genome
  41
  42
  43 Parameters and default values are listed below:
  44
  45       -pop       number of subpopulations and size of subsamples [ 2 10 10 ]
  46       -N         effective size of each subpopulation or the filename for population profile [10000]
  47       -c         number of independent regions (chromosomes) to simulate [1]
  48       -pieces    number of fragments per independent region [100]
  49       -len       length in base of each fragment [10000]
  50       -s         fixed number of SNPs per independent region (chromosome), -1 = number of SNPs follows Poisson distribution [-1]
  51       -rec       recombination rate bewteen consecutive fragments or the filename for recombination rate distribution [0.0001]
  52       -mut       mutation rate per generation per base pair [1e-08]
  53       -mig       migration rate per generation per individual [0.00025]
  54       -seed      random seed, -1 = use time as the seed [-1]
  55       -tree      1=draw the genealogy trees, 0=do not output [0]
  56       -maf       Output SNPs with minor allele frequence greater than [0]
  57       -prop      To keep this proportion of SNPs with MAF < the value of -maf parameter [1]
  58
  59
  60
  61 An example command line is:
  62
  63      genome -pop 2 3 5 -N 100 -tree 1
  64
  65 This command will simulate 3 and 5 sequences from two populations respectively.
  66 Each population is of size 100. Other parameters will take the default values listed in "[]".
  67 The genealogy trees in Newick format will be output.
  68
  69 recombination.txt contains an example of the recombination rates profile.
  70 population.txt contains an example of the population history profile.
  71 For detail of these two files please refer to the -N and -rec parameters in the manual.
  72
  73
  74 REFERENCE
  75 =========
  76 Liang L., Zollner S., Abecasis G.R. (2007) GENOME: a rapid coalescent-based whole genome simulator.
  77 Bioinformatics 23(12):1565-7
  78
  79
  80
  81 Comments and suggestions are welcome!
  82
  83 Liming Liang
  84 lianglim@umich.edu