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

ENH: add action to generate human pangenome index and filter against it #196

Merged
merged 33 commits into from
Aug 30, 2024

Conversation

misialq
Copy link
Contributor

@misialq misialq commented Aug 27, 2024

This PR adds an action allowing to:

  1. filter reads against the provided reference (mirrors filter-reads action from q2-quality-control)
  2. if no reference was provided, build one from the human pangenome sequence and Grch38 genome, filter reads against it and return both, the filtered reads and the built reference.

If anyone wants to test this before merging, you'll need to install the missing dependencies: gfatools, seqtk and q2-quality-control.

To test, execute the following:

qiime moshpit filter-reads-pangenome \
  --i-reads <some reads artifact> \
  --p-n-threads N \
  --o-filtered-reads filtered.qza \
  --o-reference-index new-index.qza

After the first go, you can then try to use the index obtained through that action to test whether things work when an index is provided:

qiime moshpit filter-reads-pangenome \
  --i-reads <some reads artifact> \
  --i-index new-index.qza \
  --p-n-threads N \
  --o-filtered-reads filtered.qza \
  --o-reference-index newer-index.qza

After the second run new-index.qza and newer-index.qza should be the same artifact.

Copy link

codecov bot commented Aug 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.93%. Comparing base (0914dd1) to head (dfb9bd8).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #196      +/-   ##
==========================================
- Coverage   98.42%   97.93%   -0.50%     
==========================================
  Files          81      150      +69     
  Lines        4448     9143    +4695     
  Branches        0      404     +404     
==========================================
+ Hits         4378     8954    +4576     
- Misses         70      140      +70     
- Partials        0       49      +49     

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

@misialq misialq marked this pull request as ready for review August 29, 2024 08:14
@misialq misialq requested review from a team and ChristosMatzoros and removed request for a team August 29, 2024 08:15
Copy link
Contributor

@ChristosMatzoros ChristosMatzoros left a comment

Choose a reason for hiding this comment

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

While I am waiting for the execution to be completed, here are some comments for some minor changes.

q2_moshpit/filtering/filter_pangenome.py Show resolved Hide resolved
q2_moshpit/plugin_setup.py Outdated Show resolved Hide resolved
q2_moshpit/plugin_setup.py Outdated Show resolved Hide resolved
q2_moshpit/plugin_setup.py Outdated Show resolved Hide resolved
Copy link
Contributor

@ChristosMatzoros ChristosMatzoros left a comment

Choose a reason for hiding this comment

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

Hi @misialq, everything looks good to me now. Ready to merge!

@misialq misialq merged commit e16ac9d into bokulich-lab:main Aug 30, 2024
10 checks passed
@misialq misialq deleted the pan-filtering branch August 30, 2024 08: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.

2 participants