filter: Expand subsampling docs #1425
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
victorlin
force-pushed
the
victorlin/subsampling-docs
branch
from
5dfc2f3 to
4137df9
Compare
victorlin
commented
Feb 24, 2024
huddlej
reviewed
Feb 26, 2024
There was a problem hiding this comment.
These docs have been needed for so long, so thank you for making them a reality, @victorlin. With the exception of some minor typos that @jameshadfield pointed out, you could easily merge this now and it would be a big help to users. I made a few comments below that mostly attempt to clarify the content for new users.
|
As a thought experiment, it would be interesting to see how we'd implement these same |
victorlin
force-pushed
the
victorlin/subsampling-docs
branch
from
5e6569a to
0a902ff
Compare
huddlej
reviewed
Feb 26, 2024
victorlin
force-pushed
the
victorlin/subsampling-docs
branch
from
12f53fc to
d7b187d
Compare
|
I've resolved all conversations above. Will merge on any approval. |
victorlin
force-pushed
the
victorlin/subsampling-docs
branch
from
b938525 to
5696adc
Compare
joverlee521
approved these changes
Feb 27, 2024
- Use section headings. - Remove references to zika-tutorial. It's largely independent of that and prone to getting out of sync. - Use --output-sequences and --output-metadata. - Fix indentation.
victorlin
force-pushed
the
victorlin/subsampling-docs
branch
from
dc6c3f6 to
08aa13c
Compare
This was referenced Mar 6, 2024
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
Expand subsampling docs with a guide on how to implement multi-pass subsampling¹.
¹ internal subsampling doc definition of "multi-pass subsampling": Subsampling done as multiple calls to a subsampling tool, where intermediate subsamples are created and joined together to create a final/combined sample. It is used to work around limitations on what can be done in a single pass.
Related issue(s)
Checklist
docs/guides/bioinformatics: Add guide on filtering and subsampling docs.nextstrain.org#192--exclude/--include(ref)