search

tskit-dev / msprime

Simulate genealogical trees and genomic sequence data using population genetic models
GNU General Public License v3.0
170 stars 84 forks source link

Clarify the meaning of the mutation rate when a matrix is used #2271

Closed hyanwong closed 3 days ago

hyanwong commented 3 months ago

In particular, that the exact transition is determined once a mutation has been laid down (so that the rate is the sum of all the possible mutation rates at that site).

This is right, isn't it @GertjanBisschop ?

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.52%. Comparing base (a2d0753) to head (7a08324).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/tskit-dev/msprime/pull/2271/graphs/tree.svg?width=650&height=150&src=pr&token=1uZQV1KMkU&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev)](https://app.codecov.io/gh/tskit-dev/msprime/pull/2271?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev) ```diff @@ Coverage Diff @@ ## main #2271 +/- ## ======================================= Coverage 91.52% 91.52% ======================================= Files 20 20 Lines 11337 11337 Branches 2304 2304 ======================================= Hits 10376 10376 Misses 523 523 Partials 438 438 ``` | [Flag](https://app.codecov.io/gh/tskit-dev/msprime/pull/2271/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev) | Coverage Δ | | |---|---|---| | [C](https://app.codecov.io/gh/tskit-dev/msprime/pull/2271/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev) | `91.52% <ø> (ø)` | | | [python](https://app.codecov.io/gh/tskit-dev/msprime/pull/2271/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev) | `98.70% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev#carryforward-flags-in-the-pull-request-comment) to find out more. ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/tskit-dev/msprime/pull/2271?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/tskit-dev/msprime/pull/2271?dropdown=coverage&src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev). Last update [a2d0753...7a08324](https://app.codecov.io/gh/tskit-dev/msprime/pull/2271?dropdown=coverage&src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev).
GertjanBisschop commented 3 months ago

The next section explains this quite well I think @hyanwong . Have a look to see if you still think we need to be more concrete in the section you modified as well.

hyanwong commented 3 months ago

Ah, good catch, I didn't properly read that.

I think it could be useful to say that the rate should be the (poisson) sum of all the separate sorts of mutation that could occur?