Skip to content

Commit

Permalink
update help about coloring types
Browse files Browse the repository at this point in the history
  • Loading branch information
emmahodcroft authored Aug 20, 2024
1 parent b744535 commit ec92bf1
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/learn/augur-to-auspice.rst
Original file line number Diff line number Diff line change
Expand Up @@ -523,6 +523,13 @@ If the type is not provided, it will be inferred in this order:
#. "continuous" if all values are numeric.
#. "categorical" if none of the above are satisfied.

To use these catgeories the data should be in the format:
- "boolean" - values should all be within ``["false", "true", "1.0", "0.0", "1", "0", "yes", "no"]``; coloring will be binary
- "continuous" - values should be numeric; coloring will be a range between the minimum & maximum values
- "temporal" - values should be dates in decimal date format (`2022.365`); coloring will be a range, and the legend will display human-readable dates
- "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

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 ec92bf1

Please sign in to comment.