Skip to content
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

More chromosome testing #123

Merged
merged 2 commits into from
Apr 19, 2024
Merged

More chromosome testing #123

merged 2 commits into from
Apr 19, 2024

Conversation

hyanwong
Copy link
Owner

@hyanwong hyanwong commented Apr 19, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a new method to identify most recent common ancestor (MRCA) regions in genetic inheritance simulations.
    • Enhanced simulation testing capabilities with additional tests for multi-chromosome scenarios and sample functionalities.
  • Improvements

    • Updated genetic resolution method to return a new genetic inheritance graph (GIG) instance, preserving the original state.
  • Tests

    • Added tests to ensure accurate functionality of new and existing features in genetic simulations.

Copy link
Contributor

coderabbitai bot commented Apr 19, 2024

Warning

Rate Limit Exceeded

@hyanwong has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 56 minutes and 3 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 88bdc18 and 5f25f60.

Walkthrough

The update introduces modifications and enhancements to the Genetic Inheritance Graph Library, focusing on improving functionality and testing. Key changes include returning a new object in the sample_resolve method for better data management and adding new test methods to ensure robustness in handling multiple chromosomes and sample-related functionalities.

Changes

Files Change Summary
.../graph.py, .../tables.py Modified sample_resolve to return new GIG; added find_mrca_regions.
tests/gigutil.py Updated loops, added print statement, adjusted default arguments in run.
tests/test_gigutil.py Added test_multi_chromosomes for no recombination between chromosomes.
tests/test_graph.py New test_samples method for testing sample functionalities.

Possibly related issues

  • Issue Order edges by child time (and ID)? #70: Discusses changes in edge ordering which might interact with gig.sample_resolve and gig.find_mrca_regions methods modified in this PR. Improved edge handling could relate to new method implementations and modifications.

🐰✨🌟
Changes abound in the code,
New tests and methods, oh how they bode!
With GIGs and graphs, we refine,
In code we trust, let it shine!
Hop, hop, hooray, for the coder's ode!
🌟✨🐰


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
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 <commit_id>.
    • Generate unit testing code 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 testing code 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 testing code.
    • @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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Comment on lines 193 to 202
def test_samples(self, trivial_gig):
assert np.all(trivial_gig.sample_ids > 0) # samples are at the end
n = 0
for u, sample in zip(trivial_gig.sample_ids, trivial_gig.samples()):
assert u == sample.id
assert sample.time == trivial_gig.nodes.time[u]
assert trivial_gig.nodes[u].is_sample()
n += 1
assert n == np.sum(trivial_gig.tables.nodes.flags & gigl.NODE_IS_SAMPLE > 0)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Potential issue with bitwise operation in assertion.

- assert n == np.sum(trivial_gig.tables.nodes.flags & gigl.NODE_IS_SAMPLE > 0)
+ assert n == np.sum((trivial_gig.tables.nodes.flags & gigl.NODE_IS_SAMPLE) > 0)

The original line might not perform the intended check correctly due to the precedence of operators. The suggested change ensures that the bitwise AND operation is evaluated before the comparison, which is likely the intended behavior.


Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
def test_samples(self, trivial_gig):
assert np.all(trivial_gig.sample_ids > 0) # samples are at the end
n = 0
for u, sample in zip(trivial_gig.sample_ids, trivial_gig.samples()):
assert u == sample.id
assert sample.time == trivial_gig.nodes.time[u]
assert trivial_gig.nodes[u].is_sample()
n += 1
assert n == np.sum(trivial_gig.tables.nodes.flags & gigl.NODE_IS_SAMPLE > 0)
def test_samples(self, trivial_gig):
assert np.all(trivial_gig.sample_ids > 0) # samples are at the end
n = 0
for u, sample in zip(trivial_gig.sample_ids, trivial_gig.samples()):
assert u == sample.id
assert sample.time == trivial_gig.nodes.time[u]
assert trivial_gig.nodes[u].is_sample()
n += 1
assert n == np.sum((trivial_gig.tables.nodes.flags & gigl.NODE_IS_SAMPLE) > 0)

@hyanwong hyanwong merged commit b7f63d4 into main Apr 19, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant