Update filtering and subsampling docs #222
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 tasks
victorlin
force-pushed
the
victorlin/update-subsampling-docs
branch
from
704f86d
to
b9ec0bb
Compare
joverlee521
previously approved these changes
Aug 16, 2024
victorlin
force-pushed
the
victorlin/update-subsampling-docs
branch
from
555a3e1
to
c334b31
Compare
victorlin
dismissed
joverlee521’s stale review
significant changes to "Filtering" section added
victorlin
changed the title
joverlee521
approved these changes
Aug 19, 2024
Reword some text and add an example for --query.
victorlin
force-pushed
the
victorlin/update-subsampling-docs
branch
from
5962ddb
to
65f8fe4
Compare
victorlin
force-pushed
the
victorlin/update-subsampling-docs
branch
from
65f8fe4
to
b5cb803
Compare
victorlin
commented
Aug 19, 2024
Comment on lines
+11
to
+16
| Overview | ||
| ======== | ||
|
|
||
| ``augur filter`` provides the flexibility to choose different subsets of input | ||
| data for various types of analysis. There are several options which can be | ||
| categorized based on the information source and selection method. |
There was a problem hiding this comment.
This new overview portion looks more like reference material that should go on the CLI page. But also, the rest of this page relies heavily on the terminology laid out here. Maybe fine to keep it here and leave the CLI page as a reference for what the options are.
jameshadfield
approved these changes
Aug 20, 2024
genehack
approved these changes
Aug 20, 2024
victorlin
force-pushed
the
victorlin/update-subsampling-docs
branch
2 times, most recently
from
96f68da
to
62e01e5
Compare
Note that I'm introducing new terminology here: "preliminary" vs. "subsampling" vs. "force-inclusive" filtering options. These are clearly distinct in the order of operations, making these labels helpful for explaining that process. For "preliminary", I had considered a term such as "exclusive" to better contrast with "force-inclusive". However, the expression syntax used for options in this category can be both exclusive (--exclude-where region!=Asia) and inclusive (--min-date 2012). This is also why "inclusive" is not a sufficient name for the "force-inclusive" category. Co-authored-by: James Hadfield <hadfield.james@gmail.com>
Reword the subsampling introduction with *what* it is, followed by examples on *why* paired with *how*. This also allows future sampling methods such as weighted sampling to be added by simply including a new section.
victorlin
force-pushed
the
victorlin/update-subsampling-docs
branch
from
62e01e5
to
5779a70
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
preview
Description of proposed changes
Prepping for upcoming weighted sampling docs. These changes are applicable to current
augur filterfeatures.Related issue(s)
Checklist