Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update help about coloring types #224

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

emmahodcroft
Copy link
Member

@emmahodcroft emmahodcroft commented Aug 20, 2024

preview

Description of proposed changes

Adding info about how to use different colouring types in the config file - what format data should be and how the colours/legend will look

src/learn/augur-to-auspice.rst Outdated Show resolved Hide resolved
- fix inline literal date example
- add required leading blank line for bullet list
- fix typo
Reordering the flow to define the color types and data requirements
first then list out inference order.
Copy link
Contributor

@joverlee521 joverlee521 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for these additions @emmahodcroft!

I added f5e5998 to fix some minor formatting issues and reordered things in 69620b8 to define the color types and data requirements first then list out inference order.

Copy link
Member

@jameshadfield jameshadfield left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Emma!


To use these categories 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[not blocking, especially as this list already existed in the previous version of the docs]

Actual numbers/booleans (as opposed to just strings) will work in Auspice but they don't always make it through augur export v2 (and I don't think we've documented which do / don't). The auspice code is:

if (["true", "1", "yes"].includes(String(val).toLowerCase()))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants