jibeproject / jibe-vis

Interactive visualisation app for exploring health impacts of urban planning scenarios based on large-scale transport and health simulation modelling.
MIT License
0 stars 0 forks source link

Incorporate reproducible data-preparation documentation #39

Open carlhiggs opened 2 hours ago

carlhiggs commented 2 hours ago

To date, I have been documenting data preparation and other development aspects in a One Note notebook. Additionally, I have been conducting these somewhat ad hoc while experimenting --- e.g. using QGIS interactively for data filtering/joining and tippecanoe at command line to generate pmtiles using the resulting data.

However, this of course is not ideal and means that some aspects --- like using tippecanoe to generate vector tile data referenced in data stories --- are not adequately documented publicly, and should processes need to be reproduced they will need to be done manually.

Moving forwards, I will be progressively documenting the process in a Quarto markdown document (.qmd file) in the data-preparation folder. R will be used to read/transform/save data, and use of additional command line utilities like felt/tippecanoe will be either described or ideally automated in that process too. The .qmd file will be rendered as a GitHub-flavoured markdown (.md) document, so that the processes used for preparing data are documented in this repository too.

The plan is to eventually transfer/consolidate the core notes from the private OneNote document related to data-prearation that I have used while developing this platform into the data-preparation document.

See the current state of the rendered data-preparation markdown document here: https://github.com/jibeproject/jibe-vis/blob/main/data-preparation/JIBE-vis-data-preparation-R.md

This issue may be closed when historical data preparation activities (eg using QGIS and tippecanoe) have been fully documented and adapted as a reproducible workflow.

carlhiggs commented 2 hours ago

see: https://github.com/jibeproject/jibe-vis/commit/7aaa81e80811487f4bcb46c5ee5b8d28166c439e https://github.com/jibeproject/jibe-vis/commit/bb7a2c85a9e932317d9b37896424193d4044f00f https://github.com/jibeproject/jibe-vis/commit/6260603c7a5f34bc7e5fcfedf0c11d63100e3a70 etc

In future commits related to this, I'll aim to tag this issue