Skip to content

Commit

Permalink
recap docs clarification and rtd fix
Browse files Browse the repository at this point in the history
  • Loading branch information
petrelharp committed Sep 23, 2019
1 parent 5366345 commit 8642d22
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 7 deletions.
9 changes: 7 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,14 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import sys
sys.path.insert(0, os.path.abspath('..'))

from unittest.mock import MagicMock

MODULES = ['msprime']
for mod_name in MODULES:
sys.modules[mod_name] = MagicMock()

# -- Project information -----------------------------------------------------

Expand Down
6 changes: 4 additions & 2 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@ that we have run for 10,000 generations without neutral mutations.
Now, we wish to extract whole-genome genotype data for only 1,000 individuals.
A typical way to do this would be to

1. :meth:`simplify` : For efficiency, subset the tree sequence to only the information relevant for those 1,000 individuals.

2. :meth:`recapitate` : The simulation has likely not reached demographic equilibrium - it has not *coalesced* entirely;
1. :meth:`recapitate` : The simulation has likely not reached demographic equilibrium - it has not *coalesced* entirely;
recapitation uses coalescent simulation to provide a "prior history" for the initial generation of the simulation.

1. :meth:`simplify` : For efficiency, subset the tree sequence to only the information relevant for those 1,000 individuals.
This needs to come *after* simplification.

3. :meth:`mutate` : This adds neutral mutations on top of the tree sequence.

These steps are described below.
Expand Down
6 changes: 3 additions & 3 deletions docs/vignette_space.rst
Original file line number Diff line number Diff line change
Expand Up @@ -550,9 +550,9 @@ than most modern ones are from each other.



*****************************
Simplification and VCF output
*****************************
**********
VCF output
**********

Now we want to write out these data for analysis with other programs.
To do this, and make sure that everything stays nicely cross-referenced,
Expand Down
3 changes: 3 additions & 0 deletions pyslim/slim_tree_sequence.py
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,9 @@ def recapitate(self, recombination_rate, keep_first_generation=False,
If you want to keep them, then set ``keep_first_generation`` to True;
although this will make more work here.
This also means that you must *not* simplify before you recapitate your
SLiM-produced tree sequence.
Note that ``Ne`` is not set automatically, so defaults to ``1.0``; you probably
want to set it explicitly. Similarly, migration is not set up
automatically, so that if there are uncoalesced lineages in more than
Expand Down
5 changes: 5 additions & 0 deletions requirements/conda-minimal.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
tskit
msprime
kastore
attr
numpy
4 changes: 4 additions & 0 deletions requirements/rtd.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
tskit
kastore
attr
numpy

0 comments on commit 8642d22

Please sign in to comment.