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

Display metadata about metrics #100

Open
vingkan opened this issue Jul 22, 2021 · 0 comments
Open

Display metadata about metrics #100

vingkan opened this issue Jul 22, 2021 · 0 comments
Labels
app Work for frontend app enhancement New feature or request refactor Work to refactor part of the codebase.

Comments

@vingkan
Copy link
Contributor

vingkan commented Jul 22, 2021

The list of metrics available to frontend features are defined in app/site/metrics.js. Currently, the metric config objects contain these fields:

  rideshare_pickups_covid: {
    name: "Rideshare Pickups Since March 2020",
    units: "trips",
    format: Formatter.numberInMillions,
    fullFormat: Formatter.numberWithCommas,
  },

In order to responsibly display data on our website, we are missing some important information:

  • Source of the data
  • Description of the metric
  • Methodological information, like sample size or other information needed to interpret the metric

We could add this information to each config object as new fields, or within a field called metadata. Any other ideas for how to design this?

@vingkan vingkan added enhancement New feature or request app Work for frontend app refactor Work to refactor part of the codebase. labels Jul 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
app Work for frontend app enhancement New feature or request refactor Work to refactor part of the codebase.
Projects
None yet
Development

No branches or pull requests

1 participant