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

Rope bwt to read mapping #274

Merged
merged 8 commits into from
Jan 24, 2025
Merged

Rope bwt to read mapping #274

merged 8 commits into from
Jan 24, 2025

Conversation

zrm22
Copy link
Collaborator

@zrm22 zrm22 commented Jan 17, 2025

Description

Adding in filter to keep haplotypes to a single reference range.

Type of change

What type of changes does your code introduce? Put an x in boxes that apply.

  • CHANGE (fix or feature that would cause existing functionality to not work as expected)
  • FEATURE (non-breaking change which adds functionality)
  • BUGFIX (non-breaking change which fixes an issue)
  • ENHANCEMENT (non-breaking change which improves existing functionality)
  • NONE (if none of the other choices apply. Example, tooling, build system, CI, docs, etc.)

Checklist:

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated relevant documentation

Changelog entry

Please add a one-line changelog entry below. This will be copied to the changelog file during the release process.

Forcing haplotypes to map to a single reference range for ropebwt3 mapping.

@zrm22 zrm22 self-assigned this Jan 17, 2025
Copy link

codecov bot commented Jan 17, 2025

Codecov Report

Attention: Patch coverage is 71.42857% with 6 lines in your changes missing coverage. Please review.

Project coverage is 80.91%. Comparing base (8af4699) to head (3cb3fa8).
Report is 20 commits behind head on main.

Files with missing lines Patch % Lines
...et/maizegenetics/phgv2/pathing/ropebwt/MapReads.kt 71.42% 4 Missing and 2 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #274      +/-   ##
==========================================
+ Coverage   80.78%   80.91%   +0.13%     
==========================================
  Files          95       95              
  Lines        7202     7159      -43     
  Branches     1205     1190      -15     
==========================================
- Hits         5818     5793      -25     
+ Misses        918      906      -12     
+ Partials      466      460       -6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

.filter { it.name.endsWith("h.vcf") || it.name.endsWith("h.vcf.gz") }.map { "${hvcfDir}/${it.name}" }
.toList()

val graph = HaplotypeGraph(hvcfFiles)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe I should add a constructor that takes a directory?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah I have had to do this a number of times and it would be very helpful just to pass a directory path.

!!! note
This document is a work in progress and will be updated as the
imputation pipeline is further developed. Please check back for
updates. As of now the pipeline is in a BETA state but is functional.
Copy link
Member

Choose a reason for hiding this comment

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

Indent the paragraph in the note block so its lined up with the note id. For example:

!!! note
    Notes go here...

updates. As of now the pipeline is in a BETA state but is functional.

In this document, we will discuss the steps needed to perform
imputation using the ropebwt3 tool within the PHG. The steps:
Copy link
Member

Choose a reason for hiding this comment

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

Add reference link to ropebwt3:

[ropebwt3](https://github.com/lh3/ropebwt3)

!!! note
The steps detailed in this document build on the materials from
the "[Building and Loading](build_and_load.md)" documentation.
Please review this if you have not worked with the PHG before!
Copy link
Member

Choose a reason for hiding this comment

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

Same as prior comment ⬆️


!!! note
This step is currently needed, but will be removed in the future as
we can do direct connections to the hVCF TileDB instance.
Copy link
Member

Choose a reason for hiding this comment

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

Same as prior ⬆️


!!! note
The following steps in the rest of this document will assume we are
in the top level of our `phg_v2_example` working directory.
Copy link
Member

Choose a reason for hiding this comment

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

Same as prior ⬆️

@zrm22 zrm22 merged commit ae572f0 into main Jan 24, 2025
2 of 4 checks passed
@zrm22 zrm22 deleted the ropeBWTToReadMapping branch January 24, 2025 16:28
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.

4 participants