maxschulz-COL commited on
Commit
e5a22b8
·
verified ·
1 Parent(s): 863e41a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +30 -1
README.md CHANGED
@@ -8,4 +8,33 @@ pinned: false
8
  license: mit
9
  ---
10
 
11
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  license: mit
9
  ---
10
 
11
+ # KPI dashboard
12
+
13
+ This demo dashboard provides an example of a Key Performance Indicator (KPI) dashboard, designed to help users get started and extend further.
14
+ It uses fictional budget data to demonstrate the capabilities of Vizro using real world applications.
15
+
16
+ Special thanks to the [#RWFD Real World Fake Data initiative](https://opendatainitiative.io/), a community project that
17
+ provides high-quality fake data for creating realistic dashboard examples for real-world applications.
18
+
19
+ Note: The data has been additionally edited for the purpose of this example.
20
+
21
+ <img src="./assets/images/kpi_dashboard.gif" alt="Gif to KPI dashboard">
22
+
23
+ ## How to run the example locally
24
+
25
+ 1. If you have `hatch` set up, run the example with the command `hatch run example kpi`. Otherwise, run the `app.py` file with your environment activated where `vizro` is installed.
26
+ 2. You should now be able to access the app locally via http://127.0.0.1:8050/.
27
+
28
+ ## Possible future iterations
29
+
30
+ - Enable selection of year filter
31
+ - Enable current year vs. past year comparison
32
+ - Enable dynamic KPI Cards
33
+ - Bar - Enable drill-downs from Issue to Sub-issue and Product to Sub-product
34
+ - Bar - Reformat numbers with commas in bar chart
35
+ - Bar - Left-align y-axis labels
36
+ - Bar - Shorten labels
37
+ - Line - Customize function to always show selected year vs. past year
38
+ - Table-view - Check why date format does not work on `Date Received`
39
+ - Table-view - Add icons to `On time?` column
40
+ - Table-view - Improve speed by applying cache or overcome limitation that entire data set is loaded in