Skip to content

Commit

Permalink
augur-to-auspice: Reorder "Configuring coloring names and types"
Browse files Browse the repository at this point in the history
Reordering the flow to define the color types and data requirements
first then list out inference order.
  • Loading branch information
joverlee521 committed Aug 20, 2024
1 parent f5e5998 commit 69620b8
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions src/learn/augur-to-auspice.rst
Original file line number Diff line number Diff line change
Expand Up @@ -517,11 +517,6 @@ metadata is to be found) to a title (how the key is to be presented in Auspice)
and a type (how should the color scale be constructed).
Setting the type to one of “continuous”, “temporal”, “ordinal”, “categorical”
or “boolean” lets Auspice use the appropriate color scale.
If the type is not provided, it will be inferred in this order:

#. "boolean" if all values are within ``["false", "true", "1.0", "0.0", "1", "0", "yes", "no"]``.
#. "continuous" if all values are numeric.
#. "categorical" if none of the above are satisfied.

To use these categories the data should be in the format:

Expand All @@ -531,6 +526,12 @@ To use these categories the data should be in the format:
- "ordinal" - values should be integers; coloring will be a range but all displayed values will be integers
- "categorical" - each unique value will receive a different color, the color wheel will be repeated if necessary

If the type is not provided, it will be inferred in this order:

#. "boolean" if all values are within boolean values defined above.
#. "continuous" if all values are numeric.
#. "categorical" if none of the above are satisfied.

The provided colorings in the auspice-config JSON will result in corresponding
metadata being exported. As mentioned above, for node-data provided metadata
this is not necessary, but if in doubt it's safest to provide this information
Expand Down

0 comments on commit 69620b8

Please sign in to comment.