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

MRG: when lingroups are provided, use them for csv_summary #3311

Open
wants to merge 14 commits into
base: latest
Choose a base branch
from

Conversation

bluegenes
Copy link
Contributor

@bluegenes bluegenes commented Aug 26, 2024

Currently, when we generate a csv_summary with LINs, we get a summary at every single LIN rank, which is a lot of results and not very helpful. LINgroups are our way of linking the LINs (e.g. 14;1;0;0;0;0;0;0;0;0) to a known name/taxonomic group (e.g. "Phylotype I").

This PR changes the behavior of csv_summary when a lingroup file is provided, limiting summarized reporting to just the named lingroups. While the output is very similar to the lingroup output we already have, the most important difference is that the sample name is included in the output, meaning that we get intelligible results when running tax metagenome on more than one sample.

Prior tax metagenome behavior was to always generate a lingroup output file when a lingroups file is provided. Here, I disable that for multiple queries, since the results wouldn't make sense. I do not replace it with another default, but I did add a recommendation to the help + doc.

In the future, we could consider changing the default lingroup output to csv_summary, since it's actually useful for multiple files. Or, we could modify the lingroup output to include query information.

Copy link

codecov bot commented Aug 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.53%. Comparing base (26b50f3) to head (cffbf38).

Additional details and impacted files
@@            Coverage Diff             @@
##           latest    #3311      +/-   ##
==========================================
+ Coverage   86.51%   86.53%   +0.01%     
==========================================
  Files         137      137              
  Lines       16023    16039      +16     
  Branches     2728     2736       +8     
==========================================
+ Hits        13863    13880      +17     
+ Misses       1851     1850       -1     
  Partials      309      309              
Flag Coverage Δ
hypothesis-py 25.36% <8.00%> (-0.04%) ⬇️
python 92.38% <100.00%> (+<0.01%) ⬆️
rust 62.26% <ø> (+0.03%) ⬆️

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

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

@bluegenes
Copy link
Contributor Author

@sourmash-bio/devs ready for review

@bluegenes bluegenes changed the title WIP: when lingroups are provided, use them for csv_summary MRG: when lingroups are provided, use them for csv_summary Sep 4, 2024
Copy link
Contributor

@ctb ctb left a comment

Choose a reason for hiding this comment

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

looks good - esp appreciate the documentation update.

there's some missing code coverage - is this just buggy codecov? I haven't dug in at all.

@ctb
Copy link
Contributor

ctb commented Sep 18, 2024

oh! I wanted to suggest that you put the suggested changes to behavior in the PR description into new issues, too; I think they require a major version bump?

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.

csv_summary format not created for multiple queries (tax metagenome)
2 participants