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

feat: add param to VCFAnnotator to optionally require validation checks #345

Merged
merged 4 commits into from
Feb 15, 2024

Conversation

korikuzma
Copy link
Contributor

close #343

  • Adds require_validation parameter. If True, validation checks must pass in order to return a VRS object. If validation checks fail, a ValueError will be raised. If False, then the VRS object will be returned even if validation checks fail.

* Adds `require_validation` parameter. If `True`, validation checks must
  pass in order to return a VRS object. If validation checks fail, a
ValueError will be raised. If `False`, then the VRS object will be
returned even if validation checks fail.
@korikuzma korikuzma self-assigned this Feb 13, 2024
@korikuzma korikuzma requested review from a team as code owners February 13, 2024 23:46
@korikuzma
Copy link
Contributor Author

@quinnwai I don't have permissions to change your permissions so you can be added as a reviewer.

@korikuzma korikuzma added enhancement New feature or request 2.0-alpha Issues related to VRS 2.0-alpha branch priority:medium Medium priority labels Feb 13, 2024
@quinnwai
Copy link
Contributor

Tested with a small vcf that...

  • annotate() skips reference validation and VRS identifies all variants with require_validation=True, compared to only partially when False
  • CLI annotation identifies all variants also when specifying --require_validation flag, and less when not specified.
  • No VRSErrors logged into output VCF when require_validation=True

Added an open question on the CLI code

@korikuzma
Copy link
Contributor Author

@ga4gh/vrs-python-maintainers Is someone able to review this so I can make a pypi release for @quinnwai?

Copy link
Contributor

@larrybabb larrybabb left a comment

Choose a reason for hiding this comment

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

codewise this looks okay to me.

@larrybabb larrybabb merged commit 0a7f817 into main Feb 15, 2024
8 checks passed
@larrybabb larrybabb deleted the issue-343 branch February 15, 2024 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.0-alpha Issues related to VRS 2.0-alpha branch enhancement New feature or request priority:medium Medium priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow reference sequence validation to be toggled for VCF annotation
3 participants