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

[Feature]: Add alignment and cigar getters #42

Draft
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

MillironX
Copy link
Member

@MillironX MillironX commented Apr 9, 2023

Closes #39

Types of changes

This PR implements the following changes:

  • ✨ New feature (A non-breaking change which adds functionality).
  • πŸ› Bug fix (A non-breaking change, which fixes an issue).
  • πŸ’₯ Breaking change (fix or feature that would cause existing functionality to change).

πŸ“‹ Additional detail

Add methods to BioAlignments.alignment and BioAlignments.cigar to pull a PairwiseAlignment and CIGAR string from a Haplotype, respectively.

See the updated docs for runnable examples.

β˜‘οΈ Checklist

  • 🎨 The changes implemented is consistent with the julia style guide.
  • πŸ“˜ I have updated and added relevant docstrings, in a manner consistent with the documentation styleguide.
  • πŸ“˜ I have added or updated relevant user and developer manuals/documentation in docs/src/.
  • πŸ†— There are unit tests that cover the code changes I have made.
  • πŸ†— The unit tests cover my code changes AND they pass.
  • πŸ“ I have added an entry to the [UNRELEASED] section of the manually curated CHANGELOG.md file for this repository.
  • πŸ†— All changes should be compatible with the latest stable version of Julia.
  • πŸ’­ I have commented liberally for any complex pieces of internal code.

@codecov
Copy link

codecov bot commented Apr 9, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +3.53 πŸŽ‰

Comparison is base (0116518) 86.52% compared to head (373e485) 90.06%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #42      +/-   ##
==========================================
+ Coverage   86.52%   90.06%   +3.53%     
==========================================
  Files           7        7              
  Lines         282      312      +30     
==========================================
+ Hits          244      281      +37     
+ Misses         38       31       -7     
Flag Coverage Ξ”
unittests 90.06% <100.00%> (+3.53%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Ξ”
src/SequenceVariation.jl 100.00% <ΓΈ> (ΓΈ)
src/Haplotype.jl 93.33% <100.00%> (+0.89%) ⬆️
src/Variation.jl 86.86% <100.00%> (+3.33%) ⬆️

... and 1 file with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

β˜” View full report in Codecov by Sentry.
πŸ“’ Do you have feedback about the report comment? Let us know in this issue.

@MillironX MillironX changed the title feat: Add _cigar(::Variation) function [Feature]: Add alignment and cigar getters Apr 9, 2023
@MillironX MillironX requested review from jakobnissen and a team April 9, 2023 01:52
@MillironX MillironX marked this pull request as draft June 24, 2023 23:33
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.

[Feature]: Add getter for alignment of a haplotype to its reference
1 participant