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

Add guide on filtering and subsampling #192

Merged
merged 2 commits into from
Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ src/guides/bioinformatics/translate_ref.md
src/guides/bioinformatics/vcf_input.md
src/guides/communicate/create-pdf.md
src/guides/communicate/narratives-intro.md
src/snippets/filtering-and-subsampling.rst
2 changes: 2 additions & 0 deletions src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@
'augur': ('https://docs.nextstrain.org/projects/augur/page/', None),
'auspice': ('https://docs.nextstrain.org/projects/auspice/page/', None),
'cli': ('https://docs.nextstrain.org/projects/cli/page/', None),
# For externally sourced snippets that reference this docs project
'docs.nextstrain.org': ('https://docs.nextstrain.org/page/', None),
victorlin marked this conversation as resolved.
Show resolved Hide resolved
'nextclade': ('https://docs.nextstrain.org/projects/nextclade/page/', None),
'ncov': ('https://docs.nextstrain.org/projects/ncov/page/', None)
}
1 change: 1 addition & 0 deletions src/fetch-docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
f'{augur_url}faq/fasta_input.md': 'guides/bioinformatics/fasta_input.md',
f'{augur_url}faq/seq_traits.md': 'guides/bioinformatics/seq_traits.md',
f'{augur_url}examples/examples.rst': 'guides/bioinformatics/examples.rst',
f'{augur_url}usage/cli/snippets/filtering-and-subsampling.rst': 'snippets/filtering-and-subsampling.rst',
}

if __name__ == '__main__':
Expand Down
11 changes: 11 additions & 0 deletions src/guides/bioinformatics/filtering-and-subsampling.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
=========================
Filtering and Subsampling
=========================

Below are some examples of using :doc:`augur filter <augur:usage/cli/filter>` to
sample data.

.. contents:: Table of Contents
:local:

.. include:: ../../snippets/filtering-and-subsampling.rst
3 changes: 2 additions & 1 deletion src/guides/bioinformatics/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ How-to guides for performing bioinformatic anaylses with Nextstrain.
:titlesonly:
:caption: Table of contents

defining-clades
filtering-and-subsampling
augur_snakemake
missing-sequence-data
translate_ref
import-beast
defining-clades
colors
lat_longs
vcf_input
Expand Down
Loading