Skip to content

Commit

Permalink
added gotchas
Browse files Browse the repository at this point in the history
  • Loading branch information
petrelharp committed Sep 25, 2018
1 parent f0229ba commit d733a60
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,26 @@ for ind in pyslim.extract_individual_metadata(mod_ts.tables):
mod_ts.dump("modified_ts.trees")
```

# Gotchas

Here are some things that you currently **cannot** do with `msprime` and `SLiM`.
They are all on our list to enable; but if you need something for your workflow
and would like to contribute, please open an issue to discuss.

1. You cannot generate mutations in `msprime`, and then use the tree sequence
to initialize a SLiM simulation. This is because SLiM requires mutations
to occur at integer positions, and `msprime` currently only generates
mutations under the infinite-sites model.

2. You cannot use `msprime` to recapitate a SLiM simulation using a recombination
map that is not uniform. This is because `msprime` and SLiM both use discrete
recombination maps, but SLiM is discrete in physical coordinates (base pairs),
while `msprime` is discrete in genetic map units. You *can* run a simulation in
SLiM using any recombination map you want, and then recapitate using a uniform
map in `msprime` (this is the default). See [the msprime documentation](https://msprime.readthedocs.io/en/latest/api.html#initialising-simulations-from-a-tree-sequence)
for more discussion of recapitation.


# Documentation

Here we describe the technical details.
Expand Down

0 comments on commit d733a60

Please sign in to comment.