specify units for recombination rate; closes #2375 #2376
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2376 +/- ##
=======================================
Coverage 90.85% 90.85%
=======================================
Files 20 20
Lines 11993 11993
Branches 2330 2330
=======================================
Hits 10896 10896
Misses 606 606
Partials 491 491
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
I'm not sure this makes this clearer either - maybe what we should do is add a note about "Units" to the documentation here and add a link to this section to the parameter docstring? |
|
Thanks @petrelharp and @jeromekelleher. I think a note in the ancestry docs would do it. I found the ancestry docs very quickly when looking for more info. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm not clear this improves things, since what exactly the units are depends? (like, probably "per generation per bp" but only if that's what time and sequence length are measured in)
Hm, I should have done this on my branch (I did this just by clicking "edit"; probably we should disable that, since the default resulting option was "commit this directly to main".)