Skip to content

Commit

Permalink
Fix linting on md files
Browse files Browse the repository at this point in the history
  • Loading branch information
luke-strange committed Sep 12, 2024
1 parent 63bfdb5 commit cd82a26
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,28 @@ A collection of open housing data processed into standardised format and present
## Site Structure

### Data

Areas: housing data for individual administrative area of England. The smallest geography is local authority district and we include everything above that up to England level.

Hex maps: Local authority district based hex maps to compare different parts of England.

Explorations: More detailed analysis of specific topics from data on this site.

### Blog Posts

A collection of blog posts associated with this website.

### Tools

Various housing tools we have helped build over the years.

### Resources
External resources like this GitHub repository and datasets used.


External resources like this GitHub repository and datasets used.

## `pipelines`
Pipelines are split by dataset. Each pipeline is split into stages:

Pipelines are split by dataset. Each pipeline is split into stages:

`extract` - get a copy of the data from the source.

Expand All @@ -33,9 +37,11 @@ Pipelines are split by dataset. Each pipeline is split into stages:
You can read more about how we build reproducible pipelines on the [Open Innovations platform website](https://open-innovations.github.io/platform/components/pipelines/).

## `metadata`

Various lookup tables and metadat on UK geographies to help generate the site. These are taken from [ONS Geoportal](https://geoportal.statistics.gov.uk/), or hand-curated.

## `data`

Split by dataset/topic. Each sub-folder contains a `site` and `standard` directory.

`standard` data are stored in a standardised format. These always include the `geography_code`, `geography_name`, `date`, `Measure` and `value` columns.
Expand All @@ -44,10 +50,12 @@ Split by dataset/topic. Each sub-folder contains a `site` and `standard` directo

In some cases, for example a `headlines.csv` file, these are in a unique format to drive a particular visualisation type, e.g. an OI Lume `dashboard`.

The logic behind including both CSV and parquet files was two-fold: parquet files are used on the site to reduce build-tim, and CSV files are included for accessibility - not everyone has a way to load and view the contents of a parquet file.
The logic behind including both CSV and parquet files was two-fold: parquet files are used on the site to reduce build-tim, and CSV files are included for accessibility - not everyone has a way to load and view the contents of a parquet file.

## `src`

The folder containing the website itself.

## Contributing
We welcome contributions to, and suggestions for, this site. If there is something you want to add, clone the site, add the changes and make a pull request. If you have a suggestion for an exploration or dataset we should include, please contact [email protected] or [email protected]

We welcome contributions to, and suggestions for, this site. If there is something you want to add, clone the site, add the changes and make a pull request. If you have a suggestion for an exploration or dataset we should include, please contact <[email protected]> or <[email protected]>
6 changes: 4 additions & 2 deletions data/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Info

Data files are grouped by their topic / dataset e.g. Affordable homes.
Each topic contains two directories: `site` and `standard`.
In `standard`, data are stored in a standardised format. These always include the `geography_code`, `geography_name`, `date`, `Measure` and `value` columns. These files are used to generate metadata and for manually checking what is in the file, if needed.
In `site`, data are stored in `parquet` files in the correct shape they need to be in to power a visualisation. This is usally a wide (or pivoted) version of the `standard` files.
In some cases, for example a `headlines.csv` file, these arae in a unique format to drive a particular visualisation type, e.g. an OI Lume `dashboard`.
In some cases, for example a `headlines.csv` file, these are in a unique format to drive a particular visualisation type, e.g. an OI Lume `dashboard`.

Any questions, suggestions, or improvements - let me know!
Any questions, suggestions, or improvements - let me know!

0 comments on commit cd82a26

Please sign in to comment.