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

filter: Update --min-length help message #1422

Merged
merged 2 commits into from
Feb 23, 2024
Merged

Conversation

joverlee521
Copy link
Contributor

@joverlee521 joverlee521 commented Feb 23, 2024

Description of proposed changes

Explicitly state that the minimum length only counts the standard nucleotide characters (A, C, G, or T).

This has been the behavior since version 3.0.3.dev1, but has never been explicitly documented outside of the filter_by_sequence_length docstring.

Related issue(s)

Prompted by @j23414's conversation in nextstrain/dengue#28 (comment)

Checklist

  • Checks pass
  • If making user-facing changes, add a message in CHANGES.md summarizing the changes in this PR

@joverlee521
Copy link
Contributor Author

Should I also update the filter_by_sequence_length report message?

include_exclude_rules.filter_by_sequence_length.__name__: "{count} {were} dropped because {they} {were} shorter than minimum length of {min_length}bp",

@joverlee521 joverlee521 requested a review from a team February 23, 2024 00:51
Copy link

codecov bot commented Feb 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.50%. Comparing base (14f5ce4) to head (b86e997).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1422   +/-   ##
=======================================
  Coverage   68.50%   68.50%           
=======================================
  Files          69       69           
  Lines        7537     7537           
  Branches     1846     1846           
=======================================
  Hits         5163     5163           
  Misses       2091     2091           
  Partials      283      283           

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

@victorlin
Copy link
Member

That is unintuitive! I think good to clarify in both the help and report messages.

@victorlin
Copy link
Member

Maybe also worth noting that it's case-insensitive.

Explicitly state that the minimum length only counts the standard
nucleotide characters A, C, G, or T (case-insensitive).

This has been the behavior since version 3.0.3.dev1, but has never been
explicitly documented outside of the `filter_by_sequence_length`
docstring.
Copy link
Contributor

@j23414 j23414 left a comment

Choose a reason for hiding this comment

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

lgtm, thanks!

@joverlee521 joverlee521 merged commit f81e6a3 into master Feb 23, 2024
20 checks passed
@joverlee521 joverlee521 deleted the filter-min-length-message branch February 23, 2024 17:35
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.

3 participants