Skip to content

Commit bc5100b

Browse files
authored
Merge pull request #1172: Update color config entries on workflow config file reference page
2 parents 56ee783 + 04b76ef commit bc5100b

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

docs/src/reference/change_log.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ We also use this change log to document new features that maintain backward comp
55

66
## New features since last version update
77

8+
- 10 February 2025: Improve documentation regarding custom color map files.
9+
810
## v16 (29 January 2025)
911

1012
- 23 January 2025: Include a new `mlr_lineage_fitness` coloring. This uses live estimates of lineage fitness from [nextstrain.org/sars-cov-2/forecasts](https://nextstrain.org/sars-cov-2/forecasts) to provide a strain-level coloring to the tree. The lineage fitness estimates are automatically updated as new data comes in and so this coloring should stay current. [PR 1169](https://github.com/nextstrain/ncov/pull/1169)

docs/src/reference/workflow-config-file.rst

+9-1
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ colors
152152
~~~~~~
153153

154154
- type: string
155-
- description: Path to a build-specific color map to use in Auspice.
155+
- description: Path to a build-specific color map file. Format: tab-delimited, no header. Each row should contain a metadata field as the first column, metadata value in the second column, and hex color code in the third column.
156156

157157
.. _configuration-builds-description:
158158

@@ -547,6 +547,14 @@ color_schemes
547547
- default: ``defaults/color_schemes.tsv``
548548
- used in rules: ``colors``
549549

550+
colors
551+
~~~~~~
552+
553+
- type: string
554+
- description: Path to a color map file. Format: tab-delimited, no header. Each row should contain a metadata field as the first column, metadata value in the second column, and hex color code in the third column.
555+
- default: colors generated from the ``colors`` rule
556+
- used in rules: ``export``
557+
550558
.. _auspice_config-1:
551559

552560
auspice_config

0 commit comments

Comments
 (0)
close