hyanwong / giglib

MIT License
4 stars 2 forks source link

Debug fwd sim #96

Closed hyanwong closed 8 months ago

hyanwong commented 8 months ago

There's a bug in the forward simulator where we manage to produce the following edges. All edges apart from the inversion should have parent_interval == child_interval:

4 IEdge(child_left=0, child_right=1, parent_left=0, parent_right=1, child=170, parent=4, edge=-1, child_chromosome=-1, parent_chromosome=-1, id=332)
4 IEdge(child_left=1, child_right=122, parent_left=200, parent_right=321, child=170, parent=5, edge=-1, child_chromosome=-1, parent_chromosome=-1, id=333)

This PR (not yet for merging) is trying to track down the bug. In particular, since the inversion is from 100-200, we shouldn't have a recombination breakpoint at 122 unless both parents 4 and 5 share the inversion in their history

It seems suspicious that the parent_left on the bad edge is 200, which is the right hand location of the inversion. I suspect there is some off-by-one problem in the recombination breakpoint calcs. Also these are the only two iedges with child == 170 which means that the child genome is only covered from 0..122 rather than 0..321 as it should be.

Summary by CodeRabbit

coderabbitai[bot] commented 8 months ago

Walkthrough

The updates across the GeneticInheritanceGraphLibrary and its tests focus on refining and enhancing the logic for genetic inheritance simulations. Key improvements include refactoring interval checks, introducing new named tuples for clarity, refining randomness in simulations, and ensuring accuracy in genetic relationship validations. These changes collectively aim to increase the library's efficiency, readability, and reliability in simulating genetic inheritance patterns.

Changes

Files Change Summary
.../graph.py Refactored interval checks in to_tree_sequence method to directly iterate over iedges and enhanced error messaging.
.../tables.py, tests/...util.py Introduced MRCAintervals and ComparablePositions named tuples, refined random_match_pos logic for inverted sequences, and updated random number generation to use rng. Improved handling of return values and added comments.
tests/test_...util.py, tests/test_tables.py Adjusted method names and return types, enhanced assertions and checks for genetic simulations, including inversion handling and validation of parent-child relationships.

šŸ‡āœØ To the code we hop and leap,
Through genetic puzzles deep.
With each change, we refine,
Ensuring logic does align.
In the warren, bright and wise,
Our code, like rabbits, multiplies.
šŸŒŸšŸ¾

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips ### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
hyanwong commented 8 months ago

Fixed and tidied for merge