Skip to content

Commit 61661a8

Browse files
committed
Update docs to reflect removal of export v1
Includes updating & adding the redirects so that v1 URLs go to the (v1→v2) migration guide as well as removal of all relevant references to "augur export v1"
1 parent 30ec7a0 commit 61661a8

File tree

6 files changed

+12
-19
lines changed

6 files changed

+12
-19
lines changed

Diff for: docs/api/developer/augur.export_v1.rst

-7
This file was deleted.

Diff for: docs/api/developer/augur.rst

-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ Submodules
3535
augur.distance
3636
augur.errors
3737
augur.export
38-
augur.export_v1
3938
augur.export_v2
4039
augur.frequencies
4140
augur.frequency_estimators

Diff for: docs/faq/colors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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.
44

5-
To specify a mapping between discrete trait values and colors, you can pass a tab-delimited file to `augur export`/`augur export v1`/`augur export v2` using `--colors`.
5+
To specify a mapping between discrete trait values and colors, you can pass a tab-delimited file to `augur export v2` using `--colors`.
66

77
> _Note that it's not currently possible to specify color schemes for nucleotides, amino acids, or continuous data._
88

Diff for: docs/faq/import-beast.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ posterior 273 0
5555
```
5656
augur import beast --mcc data/MERS_CoV_mcc.tree --output-tree results/mers.new
5757
--output-node-data results/beast_data.json
58-
augur export v1 --tree results/mers.new --node-data results/beast_data.json
58+
augur export v2 --tree results/mers.new --node-data results/beast_data.json
5959
--auspice-config config/auspice_config.json
60-
--output-tree auspice/mers_tree.json --output-meta auspice/mers_meta.json
60+
--output auspice/mers.json
6161
```
6262

6363
```

Diff for: docs/faq/metadata.rst

+4-7
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,13 @@ Consistancy and Style
7272
~~~~~~~~~~~~~~~~~~~~~
7373

7474
Check that your metadata is free from spelling mistakes and that values
75-
are consistant. Augur doesn't know that 'UK' and 'United Kingdom' or
75+
are consistent. Augur doesn't know that 'UK' and 'United Kingdom' or
7676
'cat' and 'feline' are the same!
7777

78-
Previously, auspice 'prettified' traits by capitalizing them
78+
Note: Previously, auspice 'prettified' traits by capitalizing them
7979
automatically, and removing the underscores that separated two-word
80-
locations ('new_zealand' became 'New Zealand').
81-
82-
Auspice will still do this if you are exporting 'V1' type JSON files
83-
(from augur v5 or augur v6 using ``export v1``), but will not do this if
84-
you are using ``export v2`` (:ref:`read more <prettifying-metadata-fields>`).
80+
locations ('new_zealand' became 'New Zealand'). With `augur export v2`
81+
this is no longer the case, see :ref:`read more <prettifying-metadata-fields>`.
8582
Instead, you should update your metadata files so that traits look the
8683
same as you'd like them to display in Auspice (change 'new_zealand' to
8784
'New Zealand' in your metadata, and in any additional latitude-longitude

Diff for: docs/redirects.yaml

+5-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,11 @@
8282

8383
- type: page
8484
from_url: /api/augur.export_v1.html
85-
to_url: /api/developer/augur.export_v1.html
85+
to_url: /releases/migrating-v5-v6.html
86+
87+
- type: page
88+
from_url: /api/developer/augur.export_v1.html
89+
to_url: /releases/migrating-v5-v6.html
8690

8791
- type: page
8892
from_url: /api/augur.export_v2.html

0 commit comments

Comments
 (0)