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

Addtion of info/help icons to data fields #22

Open
sjbruce opened this issue Oct 8, 2024 · 1 comment
Open

Addtion of info/help icons to data fields #22

sjbruce opened this issue Oct 8, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@sjbruce
Copy link
Member

sjbruce commented Oct 8, 2024

Each field represented from a station or as part of the hurricane track could benefit from a small explanation of their purpose and value.

For station data this could be mapped in a dictionary based on standard_names, which each field will have.

For hurricane data there will need to be some work to harmonize these values based on data source as ECCC and IBTRACS will have variations in field names.

There will be some overlap between storm and station data for fields like air pressure, wind speed and the like. Storm data will have some unique fields like wind speed radius, which could certainly benefit from additional explanation and context for users.

@sjbruce sjbruce added enhancement New feature or request documentation Improvements or additions to documentation labels Oct 8, 2024
@JaredMclellan
Copy link
Contributor

Created a branch to add to the station data: https://github.com/cioos-atlantic/atlantic-hurricane-dashboard/blob/data_field_info/react/data/station/attributes.json

Currently just uses simple hover text to deliver the definition but can change in the future. It's not apparent the definition exists as a hover without prior knowledge so perhaps can add a highlight on hover as well or something similar. Definitions are mapped to a standard name, along with a more human readable name of the variable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants