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

Clarify how priorities affect subsampling #695

Merged
merged 1 commit into from
Mar 15, 2021

Conversation

huddlej
Copy link
Contributor

@huddlej huddlej commented Mar 15, 2021

Description of proposed changes

Moves the --priority argument into the appropriate argument group (it only works as a subsampling argument), correct the existing help text to show that the input should be tab-delimited, and expand the help text to clarify how subsampling uses the given priority scores.

The output from augur filter -h for priorities now reads:

  --priority PRIORITY   tab-delimited file with list of priority scores for
                        strains (e.g., "<strain>\t<priority>") and no header.
                        When scores are provided, Augur converts scores to
                        floating point values, sorts strains within each
                        subsampling group from highest to lowest priority, and
                        selects the top N strains per group where N is the
                        calculated or requested number of strains per group.
                        Higher numbers indicate higher priority. Since
                        priorities represent relative values between strains,
                        these values can be arbitrary. (default: None)

Related issue(s)

Fixes #622

Testing

Tested by CI.

Moves the `--priority` argument into the appropriate argument group (it
only works as a subsampling argument), correct the existing help text to
show that the input should be tab-delimited, and expand the help text to
clarify how subsampling uses the given priority scores.

Fixes #622
@huddlej huddlej requested a review from cassiawag March 15, 2021 21:29
@codecov
Copy link

codecov bot commented Mar 15, 2021

Codecov Report

Merging #695 (4f30017) into master (8df4b4d) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #695   +/-   ##
=======================================
  Coverage   30.52%   30.52%           
=======================================
  Files          40       40           
  Lines        5615     5615           
  Branches     1363     1363           
=======================================
  Hits         1714     1714           
  Misses       3830     3830           
  Partials       71       71           
Impacted Files Coverage Δ
augur/filter.py 45.84% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8df4b4d...4f30017. Read the comment docs.

@huddlej huddlej added this to the Next release 11.X.X milestone Mar 15, 2021
@huddlej huddlej merged commit 517461f into master Mar 15, 2021
@huddlej huddlej deleted the document-filter-priorities branch March 15, 2021 22:34
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.

filter's priority argument is not clearly documented
1 participant