|
|
Line 1: |
Line 1: |
| | | |
− | = Data documentation<br/> = | + | = Data Documentation<br/> = |
| | | |
| All data included in the databases has be documented! | | All data included in the databases has be documented! |
Line 6: |
Line 6: |
| All abreviations have to be documentated in the Glossary! | | All abreviations have to be documentated in the Glossary! |
| | | |
− | = Naming of data = | + | = Naming of Data = |
| | | |
− | == '''Database Name''' == | + | == '''Database Name'''<br/> == |
| | | |
| The name of the database is '''oedb''' | | The name of the database is '''oedb''' |
Line 47: |
Line 47: |
| #with resolution [tupel] (e.g. per_mun) | | #with resolution [tupel] (e.g. per_mun) |
| | | |
− | Example: ''zensus_population_by_gender_per_mun'' | + | Example: ''zensus_population_by_gender_per_mun''<br/> |
| + | = Data Integrity<br/> = |
| | | |
− | === Original Data (orig) === | + | == General == |
| + | |
| + | *Primary Key [PK]<br/> |
| + | *Grants to oeuser |
| + | |
| + | == Geografic Data == |
| + | |
| + | * is '''geom''' |
| + | *Spacial Index on geom (GIST) |
| + | |
| + | = ''Data Referencing'' = |
| + | |
| + | === Original Data (orig)<br/> === |
| | | |
| <pre>{"Name": "Wirtschaftsdaten pro Region", | | <pre>{"Name": "Wirtschaftsdaten pro Region", |
Line 91: |
Line 104: |
| "Instructions for proper use": ["Always state licence"]}</pre> | | "Instructions for proper use": ["Always state licence"]}</pre> |
| | | |
− | | + | <br/> |
| | | |
| === Processed Data (calc) === | | === Processed Data (calc) === |
Line 108: |
Line 121: |
| | | |
| "ToDo": ["Some datasets are odd -> Check numbers against another data"],<br/>"Licence": ["Datenlizenz Deutschland – Namensnennung – Version 2.0 (dl-de/by-2-0; [http://www.govdata.de/dl-de/by-2-0 http://www.govdata.de/dl-de/by-2-0])"],<br/>"Instructions for proper use": ["Always state licence"]} | | "ToDo": ["Some datasets are odd -> Check numbers against another data"],<br/>"Licence": ["Datenlizenz Deutschland – Namensnennung – Version 2.0 (dl-de/by-2-0; [http://www.govdata.de/dl-de/by-2-0 http://www.govdata.de/dl-de/by-2-0])"],<br/>"Instructions for proper use": ["Always state licence"]} |
| + | <br/> |
Revision as of 08:57, 26 May 2016
Data Documentation
All data included in the databases has be documented!
All abreviations have to be documentated in the Glossary!
Naming of Data
Database Name
The name of the database is oedb
Database Schema
The structure of the database is realised via the naming of the schema!
- always lower case
- no points, no commas
- no spaces
- no dates
- use underscores
- name starts with type of schema
- orig for original data
- calc for processed data
- name includes distinct subject area or source
Example: orig_vg250
Database Table
- always lower case
- no points, no commas
- no spaces
- no dates
- use underscores
- name starts with the source (e.g. zensus)
- main value (e.g. population)
- if separated by [attribute] (e.g. by_gender)
- with resolution [tupel] (e.g. per_mun)
Example: zensus_population_by_gender_per_mun
Data Integrity
General
- Primary Key [PK]
- Grants to oeuser
Geografic Data
- is geom
- Spacial Index on geom (GIST)
Data Referencing
Original Data (orig)
{"Name": "Wirtschaftsdaten pro Region",
"Source": ["Regionaldatenbank Deutschland", "www.regionalstatistik.de / registation required"],
"Reference date": ["2013"],
"Retrieved": ["04.06.2014"],
"Date of collection": ["01.08.2013"],
"Original file": ["346-22-5.xls"],
"Spatial resolution": ["Germany"],
"Description": ["Financial key figures of German municipalities (annual totals)", "Regional level: municipalities, association of municipalities"],
"Table fields": [
{"name":"id",
"description"Unique identifier"",
"description_german":"",
"unit":"" },
{"name":"year",
"description"Reference Year"",
"description_german":"",
"unit":"" },
{"name":"example_value",
"description"Some important value"",
"description_german":"",
"unit":"EUR" }],
"Changes":[
{ "name":"Wolf-Dieter Bunke",
"mail":"wd.bunke@gmail.com",
"date":"16.06.2014",
"comment":"Created table" },
{ "name":"Cord Kaldemeyer",
"mail":"cord.kaldemeyer@fh-flensburg.de",
"date":"17.07.2014",
"comment":"Translated field names"}],
"ToDo": ["Some datasets are odd -> Check numbers against another data"],
"Licence": ["Datenlizenz Deutschland – Namensnennung – Version 2.0 (dl-de/by-2-0; [http://www.govdata.de/dl-de/by-2-0 http://www.govdata.de/dl-de/by-2-0])"],
"Instructions for proper use": ["Always state licence"]}
Processed Data (calc)
{"Name": "Results",
"Date of collection": ["01.08.2013"],
"Spatial resolution": ["Germany"],
"Description": ["Financial key figures of German municipalities (annual totals)", "Regional level: municipalities, association of municipalities"],
"Table fields": [
{"name":"id",
"description"Unique identifier"",
"description_german":"",
"unit":"" },
{"name":"year",
"description"Reference Year"",
"description_german":"",
"unit":"" },
{"name":"example_value",
"description"Some important value"",
"description_german":"",
"unit":"EUR" }],
"Changes":[
{ "name":"Wolf-Dieter Bunke",
"mail":"wd.bunke@gmail.com",
"date":"16.06.2014",
"comment":"Created table" },
{ "name":"Cord Kaldemeyer",
"mail":"cord.kaldemeyer@fh-flensburg.de",
"date":"17.07.2014",
"comment":"Translated field names"}],
"ToDo": ["Some datasets are odd -> Check numbers against another data"],
"Licence": ["Datenlizenz Deutschland – Namensnennung – Version 2.0 (dl-de/by-2-0; http://www.govdata.de/dl-de/by-2-0)"],
"Instructions for proper use": ["Always state licence"]}