Skip to content

filter: Expand subsampling docs#1425

Merged
victorlin merged 4 commits into
masterfrom
victorlin/subsampling-docs
Mar 5, 2024
Merged

filter: Expand subsampling docs#1425
victorlin merged 4 commits into
masterfrom
victorlin/subsampling-docs

Conversation

@victorlin
Copy link
Copy Markdown
Member

@victorlin victorlin commented Feb 23, 2024

(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

@victorlin victorlin self-assigned this Feb 23, 2024
@victorlin victorlin force-pushed the victorlin/subsampling-docs branch from 5dfc2f3 to 4137df9 Compare February 24, 2024 00:46
Comment thread docs/usage/cli/filter.rst Outdated
Comment thread docs/usage/cli/filter.rst Outdated
@victorlin victorlin marked this pull request as ready for review February 24, 2024 00:54
@victorlin victorlin requested a review from a team February 24, 2024 00:54
Comment thread docs/usage/cli/filter.rst Outdated
Comment thread docs/usage/cli/filter.rst Outdated
Comment thread docs/usage/cli/filter.rst Outdated
Comment thread docs/usage/cli/filter.rst Outdated
Copy link
Copy Markdown
Contributor

@huddlej huddlej left a comment

Choose a reason for hiding this comment

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

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.

Comment thread docs/usage/cli/filter.rst
Comment thread docs/usage/cli/filter.rst Outdated
Comment thread docs/usage/cli/filter.rst Outdated
Comment thread docs/usage/cli/filter.rst Outdated
Comment thread docs/usage/cli/filter.rst Outdated
Comment thread docs/usage/cli/filter.rst Outdated
Comment thread docs/usage/cli/filter.rst
Comment thread docs/usage/cli/filter.rst Outdated
Comment thread docs/usage/cli/filter.rst Outdated
Comment thread docs/usage/cli/filter.rst Outdated
@huddlej
Copy link
Copy Markdown
Contributor

huddlej commented Feb 26, 2024

As a thought experiment, it would be interesting to see how we'd implement these same augur filter subsampling examples with the proposed augur subsample command and config file. I guess it would look a bit like the subsampling block of the build config YAML?

@victorlin victorlin force-pushed the victorlin/subsampling-docs branch from 5e6569a to 0a902ff Compare February 26, 2024 22:59
Comment thread docs/usage/cli/filter.rst Outdated
@victorlin victorlin force-pushed the victorlin/subsampling-docs branch from 12f53fc to d7b187d Compare February 27, 2024 01:08
@victorlin
Copy link
Copy Markdown
Member Author

I've resolved all conversations above. Will merge on any approval.

@victorlin victorlin force-pushed the victorlin/subsampling-docs branch from b938525 to 5696adc Compare February 27, 2024 17:45
Copy link
Copy Markdown
Contributor

@joverlee521 joverlee521 left a comment

Choose a reason for hiding this comment

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

Thank you for the clear and thoughtful docs! It will be nice to be able to point users to these guides 🙏

I found one more typo and left some other non-blocking comments, but I think good to merge whenever you think it's ready.

Comment thread docs/usage/cli/filter.rst Outdated
Comment thread docs/usage/cli/filter.rst
Comment thread docs/usage/cli/filter.rst Outdated
Comment thread docs/usage/cli/filter.rst Outdated
- 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 victorlin force-pushed the victorlin/subsampling-docs branch from dc6c3f6 to 08aa13c Compare March 5, 2024 01:25
@victorlin victorlin merged commit bd6be41 into master Mar 5, 2024
@victorlin victorlin deleted the victorlin/subsampling-docs branch March 5, 2024 01: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.

4 participants