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 warning to docs fetched by docs.nextstrain.org #634

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
10 changes: 10 additions & 0 deletions docs/contribute/DEV_DOCS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# Augur Development Docs for Contributors
<!-- WARNING -->
<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
<!-- Instead, edit this file in its own repository and commit your changes there. -->
<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
<!-- This file is fetched from: https://github.com/nextstrain/augur/blob/master/docs/contribute/DEV_DOCS.md -->
<!-- WARNING -->
<!-- WARNING -->
<!-- WARNING -->

Thank you for helping us to improve Augur! This document describes:

Expand Down
11 changes: 11 additions & 0 deletions docs/examples/examples.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
=============================
Examples of Augur in the wild
=============================
..
WARNING
Do not edit this file from within the docs.nextstrain.org repository.
It is fetched from another repository to be included in the docs.nextstrain.org build.
So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost.
Instead, edit this file in its own repository and commit your changes there.
For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories
This file is fetched from: https://github.com/nextstrain/augur/blob/master/docs/examples/examples.rst
WARNING
WARNING
WARNING

We really enjoy hearing about people using Augur. If you use Augur to do your
work, we'd love to add it to this page! Let us know about it by `opening an
Expand Down
10 changes: 10 additions & 0 deletions docs/faq/colors.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# Adding Custom Trait Colors
<!-- WARNING -->
<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
<!-- Instead, edit this file in its own repository and commit your changes there. -->
<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
<!-- This file is fetched from: https://github.com/nextstrain/augur/blob/master/docs/faq/colors.md -->
<!-- WARNING -->
<!-- WARNING -->
<!-- WARNING -->

Auspice uses a number of default color schemes to color the tree using meta data or values that the augur pipeline computed. In some cases these defaults are not suitable for particular type of data, and you'd like to use your own color schemes.

Expand Down
12 changes: 11 additions & 1 deletion docs/faq/fasta_input.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# Using Fasta Input
<!-- WARNING -->
<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
<!-- Instead, edit this file in its own repository and commit your changes there. -->
<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
<!-- This file is fetched from: https://github.com/nextstrain/augur/blob/master/docs/faq/fasta_input.md -->
<!-- WARNING -->
<!-- WARNING -->
<!-- WARNING -->

If you would like to run augur on viral data, or bacterial SNP data, you probably would like to start with Fasta sequence data.

Expand All @@ -8,4 +18,4 @@ Your sequence data should

* consist of homologous sequences that can be aligned unambiguously
* needs to contain sufficient diversity to allow reliable tree reconstruction
* should be of similar length. Mixing short sequences (300bp) with much longer ones (10000bp) often yields unexpected results.
* should be of similar length. Mixing short sequences (300bp) with much longer ones (10000bp) often yields unexpected results.
11 changes: 11 additions & 0 deletions docs/faq/import-beast.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
## Importing BEAST MCC trees into augur
<!-- WARNING -->
<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
<!-- Instead, edit this file in its own repository and commit your changes there. -->
<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
<!-- This file is fetched from: https://github.com/nextstrain/augur/blob/master/docs/faq/import-beast.md -->
<!-- WARNING -->
<!-- WARNING -->
<!-- WARNING -->


This documentation details how to import BEAST MCC trees using `augur import beast`.
Currently this is most useful for producing auspice-compatable output using `augur export`, however in the future we will provide instructions on how to perform additional analysis using other augur tools.
Expand Down
10 changes: 10 additions & 0 deletions docs/faq/lat_longs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# Adding Custom Lat-Long Data
<!-- WARNING -->
<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
<!-- Instead, edit this file in its own repository and commit your changes there. -->
<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
<!-- This file is fetched from: https://github.com/nextstrain/augur/blob/master/docs/faq/lat_longs.md -->
<!-- WARNING -->
<!-- WARNING -->
<!-- WARNING -->

To place sequences on a map, auspice needs to know where the locations you specify are on the globe. These coordinates are provided by augur and augur has preset coordinates for many places. For example, for `region`, `country`, and some `division`s augur already knows many lat-long coordinates (see which ones it already knows by checking the list [here](https://github.com/nextstrain/augur/blob/master/augur/data/lat_longs.tsv)).

Expand Down
10 changes: 10 additions & 0 deletions docs/faq/seq_traits.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# Inferring Sequence Traits (like Drug Resistance)
<!-- WARNING -->
<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
<!-- Instead, edit this file in its own repository and commit your changes there. -->
<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
<!-- This file is fetched from: https://github.com/nextstrain/augur/blob/master/docs/faq/seq_traits.md -->
<!-- WARNING -->
<!-- WARNING -->
<!-- WARNING -->

<span style="color:red">Unfortunately this method currently only works with VCF-input files. It will be updated to work with Fasta-input soon!

Expand Down
12 changes: 11 additions & 1 deletion docs/faq/translate_ref.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# Finding a `translate` and `align` reference file
<!-- WARNING -->
<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
<!-- Instead, edit this file in its own repository and commit your changes there. -->
<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
<!-- This file is fetched from: https://github.com/nextstrain/augur/blob/master/docs/faq/translate_ref.md -->
<!-- WARNING -->
<!-- WARNING -->
<!-- WARNING -->

In order to correctly align and annotate the genes in your sequences, augur uses an annotated reference sequence in 'Genbank' format (if Fasta input) or 'GFF' format (if VCF input).

Expand Down Expand Up @@ -38,4 +48,4 @@ You can also find an appropriate GFF annotation reference on GenBank. Be sure to

To download a file from GenBank, use the 'send to' button in the top-right corner, then select 'Complete Record', 'File', and 'GFF3' for the format.

You will have to modify the first column of the GFF so that it matches the `CHROM` (first column) of your VCF file.
You will have to modify the first column of the GFF so that it matches the `CHROM` (first column) of your VCF file.
12 changes: 11 additions & 1 deletion docs/faq/vcf_input.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# Using VCF Input
<!-- WARNING -->
<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
<!-- Instead, edit this file in its own repository and commit your changes there. -->
<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
<!-- This file is fetched from: https://github.com/nextstrain/augur/blob/master/docs/faq/vcf_input.md -->
<!-- WARNING -->
<!-- WARNING -->
<!-- WARNING -->

If you would like to run augur on whole-genome bacterial data, you probably would like to start with VCF sequence data. (Note that if you have bacterial SNP data, this may be in Fasta format.)

Expand Down Expand Up @@ -29,4 +39,4 @@ NC_000962 80194 80623 IG71_Rv0071-Rv0072

_(Optional)_ Bacteria can have thousands of genes, and translating all of them can take quite a bit of time. If you wouldn't like to translate all of them, you can provide a list of genes that you'd like to include in the analysis, and only these will be processed. For example, you might include a list of genes that are associated with drug-resistance.

To do this, simply create a file with a list of the genes you'd like to include, with one gene name per line. You can then pass this to `augur translate`.
To do this, simply create a file with a list of the genes you'd like to include, with one gene name per line. You can then pass this to `augur translate`.
10 changes: 10 additions & 0 deletions docs/installation/installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# Installation
<!-- WARNING -->
<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
<!-- Instead, edit this file in its own repository and commit your changes there. -->
<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
<!-- This file is fetched from: https://github.com/nextstrain/augur/blob/master/docs/installation/installation.md -->
<!-- WARNING -->
<!-- WARNING -->
<!-- WARNING -->

* [Using conda](#using-conda)
* [Using pip from PyPi](#using-pip-from-pypi)
Expand Down
10 changes: 10 additions & 0 deletions docs/tutorials/tb_tutorial.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# MTb tutorials using vcf data
<!-- WARNING -->
<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
<!-- Instead, edit this file in its own repository and commit your changes there. -->
<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
<!-- This file is fetched from: https://github.com/nextstrain/augur/blob/master/docs/tutorials/tb_tutorial.md -->
<!-- WARNING -->
<!-- WARNING -->
<!-- WARNING -->

This tutorial explains how to create a Nextstrain build for Tuberculosis sequences.
However, much of it will be applicable to any run where you are starting with [VCF](https://en.wikipedia.org/wiki/Variant_Call_Format) files rather than [FASTA](https://en.wikipedia.org/wiki/FASTA_format) files.
Expand Down
10 changes: 10 additions & 0 deletions docs/tutorials/zika_tutorial.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# Zika tutorial -- fasta input
<!-- WARNING -->
<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
<!-- Instead, edit this file in its own repository and commit your changes there. -->
<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
<!-- This file is fetched from: https://github.com/nextstrain/augur/blob/master/docs/tutorials/zika_tutorial.md -->
<!-- WARNING -->
<!-- WARNING -->
<!-- WARNING -->

The tool-chain [*augur*](https://github.com/nextstrain/augur) is the bioinformatics engine of nextstrain and produces the files that can be visualized in the webbrowser using [*auspice*](https://github.com/nextstrain/auspice).
Augur consists of a number of tools that allow the user to filter and align sequences, build trees, and integrate the phylogenetic analysis with meta data.
Expand Down
10 changes: 10 additions & 0 deletions docs/usage/augur_snakemake.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
## Augur and snakemake
<!-- WARNING -->
<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
<!-- Instead, edit this file in its own repository and commit your changes there. -->
<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
<!-- This file is fetched from: https://github.com/nextstrain/augur/blob/master/docs/usage/augur_snakemake.md -->
<!-- WARNING -->
<!-- WARNING -->
<!-- WARNING -->

The output of one augur command serves as input to the next and hence these commands need to be executed in order.
This is a common pattern in bioinformatics and multiple tools -- so called workflow managers -- exist to facilitate this.
Expand Down