added READMEs, restructure a few things
This commit is contained in:
parent
463f52d57f
commit
fa37e0744f
14
README.md
14
README.md
|
@ -29,11 +29,15 @@ If you would like to see a visualization that does not exist yet based on the av
|
|||
- [ ] abstract plot creation process and store in seperate directory
|
||||
- [ ] abstract away utility functions used in python script
|
||||
- [ ] re-format theme to be main visualization dashboard with associated research articles as secondary
|
||||
- [ ] host on github pages to subdomain of Status.im
|
||||
- [ ] add guide on creating an article and using Hugo/Distill
|
||||
- [x] add README for plot folder
|
||||
- [x] add README for data folder
|
||||
### Content
|
||||
- [ ] create main SNT visualization dashboard
|
||||
- [ ] finish initial SNT Distribution Analys draft article
|
||||
- [ ] finish initial SNT Distribution Analsys draft article
|
||||
### Plots
|
||||
- [ ] create plot - stale funds vs current
|
||||
- [ ] create plot - order of magnitude plot
|
||||
- [ ] create plot - change exchange bar to treemap
|
||||
- [ ] create plot - treemap of distribution across Status
|
||||
- [ ] all holders - stale funds vs current
|
||||
- [ ] community - order of magnitude plot
|
||||
- [ ] exchanges - change exchange bar to treemap
|
||||
- [ ] status - treemap of distribution across Status
|
|
@ -0,0 +1,6 @@
|
|||
# Data Files
|
||||
This directory holds the base data files and derivative data files used for plotting and analysis.
|
||||
|
||||
## Base data formats
|
||||
|
||||
## Linking to data within an analysis file or Vega visualization
|
|
@ -0,0 +1,16 @@
|
|||
# Plots Information
|
||||
All interactive plots are created via the [Vega-Lite](https://vega.github.io/vega-lite/) or [Vega](https://vega.github.io/vega/) API. Both the derivative datasets and visualization specifications can be auto-generated via the [python script](../../munge_and_generate_plots.py) that is manually run before a PR is submitted.
|
||||
|
||||
## plot data generation
|
||||
|
||||
In order for a Vega file to be rendered it will need to refer to a dataset. For most plots, the [base dataset](../data_csv) files will not be formatted appropriately even though all information is present within it.
|
||||
|
||||
### Manual python script generation of derivative datasets
|
||||
Currently, derivative datasets that are used for plots are generated in the python script mentioned above.
|
||||
|
||||
If the python script is altered, it will need to be executed before any PR is accepted, so that all derivative files are updated before being hosted. This process will eventually be automated (hopefully).
|
||||
|
||||
### Vega transform Grammar
|
||||
Alternatively, [Vega](https://vega.github.io/vega/docs/transforms/) and [Vega-Lite](https://vega.github.io/vega-lite/docs/transform.html) have a transform grammar that allows for data transformations in the specification itself. This is more complicated but cleaner way to provide visualizations.
|
||||
|
||||
If this is used, then it is recommended to use the large [`holders_munged.csv`](../../data_csv/holders_munged.csv) dataset as it has all base data combined into a single set.
|
Before Width: | Height: | Size: 8.4 KiB After Width: | Height: | Size: 8.4 KiB |
Loading…
Reference in New Issue