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: add --set-name to sig intersect and sig subtract #3162

Merged
merged 26 commits into from
Jun 4, 2024
Merged

Conversation

ctb
Copy link
Contributor

@ctb ctb commented May 14, 2024

Note: PR into #3161

This PR cleans up and regularizes naming output on sig subcommands. Specifically, it:

  • adds --set-name to sig intersect and sig subtract to set names on output signatures.
  • confirms and tests default names for output from sig inflate, sig filter, sig downsample, and sig flatten
  • updates documentation appropriately
  • aliases --name to --set-name on sig merge, and nominates --name for deprecation and removal on v5
  • nominates --name on sig extract, sig filter, and sig flatten for deprecation and removal on v5
  • highlights --name on sketch dna, sketch protein, and sketch translate - ref sketch ... --name is not documented in CLI help  #3152

Fixes #1801
Fixes #3152

Related issues:

Copy link

codecov bot commented May 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.67%. Comparing base (9283dc4) to head (d3caff1).

Additional details and impacted files
@@           Coverage Diff           @@
##           latest    #3162   +/-   ##
=======================================
  Coverage   86.67%   86.67%           
=======================================
  Files         136      136           
  Lines       15830    15832    +2     
  Branches     2716     2716           
=======================================
+ Hits        13720    13722    +2     
  Misses       1800     1800           
  Partials      310      310           
Flag Coverage Δ
hypothesis-py 25.35% <0.00%> (-0.01%) ⬇️
python 92.33% <100.00%> (+<0.01%) ⬆️
rust 62.09% <ø> (ø)

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.

@ctb ctb changed the title WIP: add --name to sig intersect and sig subtract MRG: add --set-name to sig intersect and sig subtract May 24, 2024
@ctb
Copy link
Contributor Author

ctb commented May 24, 2024

ready for review @sourmash-bio/devs !

Copy link
Contributor

@bluegenes bluegenes left a comment

Choose a reason for hiding this comment

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

lgtm!

Base automatically changed from rename_sig_json_fns to latest June 4, 2024 18:26
@ctb ctb merged commit a133e68 into latest Jun 4, 2024
38 of 39 checks passed
@ctb ctb deleted the provide_name_on_sig branch June 4, 2024 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants