Skip to content

Commit

Permalink
Add guide on filtering and subsampling
Browse files Browse the repository at this point in the history
Uses a snippet from the Augur docs.
  • Loading branch information
victorlin committed Mar 6, 2024
1 parent 2ca0b72 commit 962e76e
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 0 deletions.
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
1 change: 1 addition & 0 deletions src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@
'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),
'docs.nextstrain.org': ('https://docs.nextstrain.org/page/', None),
'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
1 change: 1 addition & 0 deletions src/guides/bioinformatics/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ How-to guides for performing bioinformatic anaylses with Nextstrain.
:caption: Table of contents

defining-clades
filtering-and-subsampling
augur_snakemake
missing-sequence-data
translate_ref
Expand Down

0 comments on commit 962e76e

Please sign in to comment.