Minimal export (no node-data files needed) #1299
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,12 +12,11 @@ | |
| "type" : "string" | ||
| }, | ||
| "colorings": { | ||
| "description": "Traits available as color-by options", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "description": "Each object here is an individual coloring, which will populate the sidebar dropdown in auspice", | ||
| "additionalProperties": false, | ||
| "required": ["key"], | ||
| "properties": { | ||
|
|
@@ -32,19 +31,20 @@ | |
| }, | ||
| "type": { | ||
| "description": "Defines how the color scale should be constructed", | ||
| "$comment": "[augur export v2] will (try to) infer the type if this is not present", | ||
| "type": "string", | ||
| "enum": ["continuous", "temporal", "ordinal", "categorical", "boolean"] | ||
| }, | ||
| "scale": { | ||
| "description": "Provided mapping between trait values & hex values. For continuous scales at least 2 items must be specified", | ||
| "$comment": "[auspice export v2] preferentially uses this over colors TSV", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "array", | ||
| "items": [ | ||
| { | ||
| "type": ["string", "number"], | ||
| "description": "For categorical/ordinal scales, this is the (string) value of the trait to associate with the colour. For continuous scales this is the (numeric) value to associate with the colour, and interpolation will be used to span the domain" | ||
| }, | ||
| {"type": "string", "description": "color hex value", "pattern": "^#[0-9A-Fa-f]{6}$"} | ||
| ] | ||
|
|
@@ -143,28 +143,31 @@ | |
| }, | ||
| "build_url": { | ||
| "description": "URL with instructions to reproduce build, usually expected to be a GitHub repo URL", | ||
| "$comment": "Auspice displays this at the top of the page as part of a byline", | ||
| "type": "string" | ||
| }, | ||
| "filters": { | ||
| "description": "These appear as filters in the footer of Auspice (which populates the displayed values based upon the tree)", | ||
| "$comment": "These values must be present as keys on a tree node -> trait", | ||
| "type": "array", | ||
| "uniqueItems": true, | ||
| "items": {"type": "string"} | ||
| }, | ||
| "display_defaults": { | ||
| "description": "Set the defaults for certain display options in Auspice. All are optional.", | ||
| "$comment": "Anything able to be encoded in the auspice URL should eventually be an option here, so this will expand over time", | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "map_triplicate": { | ||
| "type": "boolean" | ||
| }, | ||
| "geo_resolution": { | ||
| "$comment": "The value here must be present in geo_resolutions (see above)", | ||
| "type": "string" | ||
| }, | ||
| "color_by": { | ||
| "$comment": "The value here must be present in the colorings (see above)", | ||
| "type": "string" | ||
| }, | ||
| "distance_measure": { | ||
|
|
@@ -181,7 +184,13 @@ | |
| "type": "string", | ||
| "pattern": "^(none|[a-zA-Z0-9]+)$" | ||
| }, | ||
| "tip_label": { | ||
|
There was a problem hiding this comment. The inclusion of I've made an issue for better support of different auspice schema versions here: #1326 |
||
| "description": "What tip label should be displayed by default, or 'none' to hide labels by default.", | ||
| "$comment": "Should be a key present in (at least some) node_attrs", | ||
| "type": "string" | ||
| }, | ||
| "transmission_lines": { | ||
| "$comment": "Transmission lines depend on the geo_resolution being defined for internal nodes", | ||
| "type": "boolean" | ||
| }, | ||
| "language": { | ||
|
|
@@ -195,8 +204,7 @@ | |
| }, | ||
| "panels": { | ||
| "type": "array", | ||
| "description": "Panels which start toggled on (default is for all available to be shown)", | ||
| "minItems": 1, | ||
| "items": { | ||
| "type": "string", | ||
|
|
@@ -217,9 +225,9 @@ | |
| "type": "string" | ||
| }, | ||
| "panels": { | ||
| "description": "The panels available for display", | ||
| "$comment": "The frequencies & measurements panel will only be available if defined here (and if their sidecar files are available)", | ||
| "type": "array", | ||
| "minItems": 1, | ||
| "items": { | ||
| "type": "string", | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Allowed per validation in auspice-config but not yet supported by current auspice 🙃
I think my preference would be to first allow something in Auspice, then add it to schema, rather than other way round - but I guess as long as auspice still works and just lacks a minor default feature, it's no a big deal either way.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah totally, I forgot that auspice PR hadn't been merged + released. I'll do that today
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Auspice 2.49.0 released which parses this display_default. It'll appear on nextstrain.org / auspice.us etc over the coming day or two