Msprime: Clean up mutations/models docs

Created on 27 Jan 2021  路  8Comments  路  Source: tskit-dev/msprime

1409 made a small update to the mutations part of the docs. There's a few updates that we need to make to bring the "models" section up to date:

  • Make sure we use sim_mutations and sim_ancestry in all the examples
  • Update the examples to use jupyter code blocks (see the ancestry.md page for examples to follow here) and delete the old images from the repo
documentation help wanted

All 8 comments

Happy to address this! I happened to be working with the new mutation models this week anyway

The msprime.SLiMMutationModel example includes a parameter called allow_ancestral. I can't find where this is documented, does it not exist anymore?

See https://github.com/tskit-dev/msprime/issues/1206#issuecomment-768562378 for the proposal on this (and documentation).

Ah great, thanks @petrelharp

Another point: the SVG and the text of "Infinite Alleles Mutation Models" don't match up. The text seems to indicate that there are multiple copies of the same allele. Maybe I'm missing something fundamental about this example, but the point of Infinite Alleles is that each allele is new?

Screenshot 2021-01-30 at 7 06 09 PM

I meant that five of the samples inherited allele 13, etcetera.

Don't 8 samples inherit allele 13?
Edit, ah sorry peter, was being dense and didn't see that it's a single site so there's overwriting

Heh, this is exactly why I put that sentence in, to make the reader notice things like it being a single site. =) But, clearly it needs to say what's going on a bit more explicitly.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jeromekelleher picture jeromekelleher  路  7Comments

jeromekelleher picture jeromekelleher  路  3Comments

jeromekelleher picture jeromekelleher  路  4Comments

jeromekelleher picture jeromekelleher  路  11Comments

jeromekelleher picture jeromekelleher  路  13Comments