department-for-transport-BODS / bods-data-extractor

A python client for downloading and extracting data from the UK Bus Open Data Service
Other
47 stars 10 forks source link

Explain the data quality outputs (or link to BODS documentation) (2) #71

Open EOstridge opened 1 year ago

EOstridge commented 1 year ago

Is your feature request related to a problem? Please describe.

As a data consumer, it would be helpful to understand the terms referenced in the data quality outputs.

Describe the solution you'd like

There are some terms within the Reporting and Analytics section of the README that do not have any explanation. Explanation of these terms would make the outputs easier to understand. For example, what is TxC 2.4? What is red quality data? What are the impacts of low data quality that the user should bear in mind during analysis? Should a data quality/summary report run automatically on successful download of data - and what does this mean?

image

adamakram1 commented 1 year ago

Link to dq standards, potentially BODS data quality

adamakram1 commented 1 year ago

https://publish.bus-data.dft.gov.uk/guidance/operator-requirements/?section=dataquality

adamakram1 commented 1 year ago

Add To glossary of terms

adamakram1 commented 1 year ago

Value(2)