-
Notifications
You must be signed in to change notification settings - Fork 86
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
N function in pedigree sims #2322
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2322 +/- ##
=======================================
Coverage 90.93% 90.93%
=======================================
Files 20 20
Lines 12014 12018 +4
Branches 2438 2439 +1
=======================================
+ Hits 10925 10929 +4
Misses 602 602
Partials 487 487
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
LGTM - just needs some light test coverage I guess. Some ideas:
|
I've tried. Do the added tests make sense? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, just need to reformat the docstring style.
msprime/pedigrees.py
Outdated
""" | ||
Simulates a pedigree | ||
|
||
Arguments: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you reformat this using sphinx :param: sections like the rest of the code please?
Great! Can you squash down to one commit please? (See dev docs for guidance) |
c670ac2
to
97f7f91
Compare
NB, squashing is mentioned only in the tskit dev docs, I think. |
When simulating pedigrees, one needs to set a population size N. This PR adds functionality for N to be a function of the generation (back in time). This works for forward and backward pedigree simulations.