feat: extend tree extensions node clade attrs to be more descriptive #741
Conversation
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
Extends the Nextclade's Augur tree extension object to provide more data (friendly name of the column and description for the tooltip).
Replaces the `meta.extensions.nextclade.clade_node_attr_keys`array of strings with `meta.extensions.nextclade.clade_node_attrs` array of objects in the auspice tree json.
The expected format is as follows:
```json
{
"meta": {
"extensions": {
"nextclade": {
"clade_node_attrs": [
{
"name": "pango_lineage",
"displayName": "Pango lineage (Nextclade)",
"description": "Pango lineage as inferred by Nextclade from the nearest neighbour in the reference tree. 98% accurate for recent sequences, for higher accuracy use dedicated pangolin software in UShER or pangoLEARN mode",
},
{
"name": "GISAID_clade",
"displayName": "GISAID clade",
"description": "Clades as defined by GISAID"
}
]
}
}
}
}
```
All keys are optional, but if at least one key is missing, the object will be ignored. Sam as if it's not an object. The entire extension object is optional as well. More fields can be added, if necessary.
Testing: paste the example from above into the existing tree `meta` object and drop it into the web's advanced mode or into cli's `--input-tree`.
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/nextstrain/nextclade/EFZfsyC3VMuNcCcfoUVHWx3kcWDy |
|
Works great, will merge so I can use this on master with a dataset that enables this mode. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Extends the Nextclade's Augur tree extension object to provide more data (friendly name of the column and description for the tooltip).
Replaces the
meta.extensions.nextclade.clade_node_attr_keysarray of strings withmeta.extensions.nextclade.clade_node_attrsarray of objects in the auspice tree json.The expected format is as follows:
{ "meta": { "extensions": { "nextclade": { "clade_node_attrs": [ { "name": "pango_lineage", "displayName": "Pango lineage (Nextclade)", "description": "Pango lineage as inferred by Nextclade from the nearest neighbour in the reference tree. 98% accurate for recent sequences, for higher accuracy use dedicated pangolin software in UShER or pangoLEARN mode" }, { "name": "GISAID_clade", "displayName": "GISAID clade", "description": "Clades as defined by GISAID" } ] } } } }All keys are optional, but if at least one key is missing, the object will be ignored. Same as if it's not an object. The entire extension object is optional as well. More fields can be added, if necessary.
Testing: paste the example from above into the existing tree
metaobject and drop it into the web's advanced mode or into cli's--input-tree.