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

MAINT: Removed "overall-mapping-stats.txt" from CARDGeneAnnotationDirectoryFormat #29

Merged

Conversation

VinzentRisch
Copy link
Collaborator

@VinzentRisch VinzentRisch commented Jan 10, 2024

This PR fixes #28 and #30

  • Removed "overall-mapping-stats.txt" from CARDGeneAnnotationDirectoryFormat.
  • Changed the input of visualize-annotation-stats to only accept CARDAlleleAnnotation because the stats file is now only included in the CARDAlleleAnnotationDirectoryFormat.
  • Changed CARDAlleleAnnotation to SampleData[CARDAlleleAnnotation] in the input plugin_setup of visualize-annotation-stats.
  • Changed annotate-reads-card so that "overall-mapping-stats.txt" only gets moved to the CARDAlleleAnnotation artifact.

To test annotate-reads-card action, download test files and run this (takes about 3 mins):

qiime amr annotate-reads-card --i-reads 25mb_reads.qza --i-card-db card_db.qza --output-dir test_q2_amr_29 --p-threads 2

To test visualize-annotation-stats run this:

qiime amr visualize-annotation-stats --i-amr-reads-annotation test_q2_amr_29/amr_allele_annotation.qza --o-visualization test_q2_amr_29/amr_allele_annotation_stats.qzv

@codecov-commenter
Copy link

codecov-commenter commented Jan 10, 2024

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (898241c) 66.70% compared to head (c7102bf) 66.58%.

Files Patch % Lines
q2_amr/card/reads.py 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #29      +/-   ##
==========================================
- Coverage   66.70%   66.58%   -0.13%     
==========================================
  Files          13       13              
  Lines         835      832       -3     
==========================================
- Hits          557      554       -3     
  Misses        278      278              

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

@VinzentRisch VinzentRisch requested a review from Sann5 January 11, 2024 11:20
@VinzentRisch
Copy link
Collaborator Author

Hi Santiago :) This is again a very small one with no new functionality.
I added the test data to download and the command to run. Everything should run quickly without any problems.

@Sann5
Copy link

Sann5 commented Jan 11, 2024

Coolioou, I'll check it out :).

@Sann5
Copy link

Sann5 commented Jan 11, 2024

In your second bullet point of the PR message you say

Changed the input of visualize-annotation-stats to only accept CARDAlleleAnnotation because the stats file is now only included in the CARDGeneAnnotationDirectoryFormat.

Do you mean?

Changed the input of visualize-annotation-stats to only accept CARDAlleleAnnotation because the stats file is now only included in the CARDAlleleAnnotationDirectoryFormat.

Copy link

@Sann5 Sann5 left a comment

Choose a reason for hiding this comment

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

  • ✅ I all looks good to me!
  • ✅ All test pass locally.
  • annotate-reads-card and visualize-annotation-stats run without problems. I did not inspect the outputs to make sure that made sense (not that I could either), but I guess you did this :)
  • ❓Im just curious about one thing. How come you decided to set "amr_reads_annotation": SampleData[CARDAlleleAnnotation] and not "amr_reads_annotation": CARDAlleleAnnotation. I'm not an expert on Semantic Types so It's not so obvious why one would choose one over the other. Also apparently you already had CARDAlleleAnnotation registered as a type of SampleData before this PR so I am confused why you didn't use it before.

@VinzentRisch
Copy link
Collaborator Author

Thank you! 👍
Thanks for pointing that out, I did mean CARDAlleleAnnotationDirectoryFormat. :)

And it should have been SampleData[CARDAlleleAnnotation] from the start. That was a bug, visualize-annotation-stats did not work some time before this fix.
So you can't choose the one or the other.

@VinzentRisch VinzentRisch merged commit 3f01352 into bokulich-lab:main Jan 12, 2024
5 checks passed
@VinzentRisch VinzentRisch deleted the 28_remove_stats_from_gene branch January 12, 2024 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants