|
|
| (118 intermediate revisions by 5 users not shown) |
| Line 1: |
Line 1: |
| | + | {{GlossaryTermTemp |
| | + | |SubtermOf=Database |
| | + | }} |
| | + | = OpenEnergy Data Base (oedb)<br/> = |
| | | | |
| − | == Data documentation ==
| + | The following database rules explain the basic principles of the database called oedb, which will become a part of the openmod internet presence. For further details see also [[Database|here]].<br/> |
| | | | |
| − | All data included in the databases has be documented!
| + | == Open Data<br/> == |
| | | | |
| − | == Naming of data == | + | *Only use data with suitable licences<br/> |
| | + | *<span lang="EN-US">Do not upload restricted data into the database</span><br/> |
| | | | |
| − | '''Database Name'''
| + | More Information can be found on [[Choosing a license|Open Licenses.]] Additional, the Project Open Power System Data is dealing this topic on [http://open-power-system-data.org/legal OPSD - Legal]. |
| | | | |
| − | The name of the database is '''oedb'''
| + | <br/> |
| | | | |
| − | '''Database Schema'''
| + | <br/> |
| | | | |
| − | The structure of the database is realised via the naming of the schema!
| + | == Data Documentation<br/> == |
| | | | |
| − | *always lower case | + | *All data included in the databases has be documented! On this wiki page you learn how to do so<br/> |
| − | *no points, no commas | + | *All abreviations have to be documentated in the of the openmod wiki<br/> |
| − | *no spaces
| + | |
| − | *no dates
| + | |
| − | *use underscores
| + | |
| | | | |
| | + | == Naming of Data<br/> == |
| | | | |
| | + | *The nomenclature should follow a logical structure<br/> |
| | + | *There are different levels of naming<br/> |
| | | | |
| − | #name starts with type of schema
| + | === Database Name<br/> === |
| − | #*'''orig''' for original data
| + | |
| − | #*'''calc''' for processed data
| + | |
| | | | |
| − | #name includes distinct subject area or source
| + | *The name of the database is<br/> |
| | | | |
| − | Example: ''orig_vg250''
| + | <br/> |
| | | | |
| − | <br/>'''Database Table''' | + | <br/> |
| | + | |
| | + | === Database Schema<br/> === |
| | + | |
| | + | you find the current version of the oedb schema [[Database schema|here]]<br/><br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | === Database Table<br/> === |
| | | | |
| | *always lower case<br/> | | *always lower case<br/> |
| Line 37: |
Line 48: |
| | *no dates<br/> | | *no dates<br/> |
| | *use underscores | | *use underscores |
| | + | *use ASCII characters only |
| | | | |
| | + | <br/> |
| | | | |
| | + | The table name consists of |
| | | | |
| − | #name starts with the source (e.g. zensus) | + | #name starts with the source, project or model name (e.g. zensus, eGo) |
| | #main value (e.g. population) | | #main value (e.g. population) |
| | #if separated by [attribute] (e.g. by_gender) | | #if separated by [attribute] (e.g. by_gender) |
| | #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/><br/> |
| | + | |
| | + | Remember to put your abbreviations in the Glossary |
| | + | |
| | + | <br/> |
| | + | |
| | + | === Database View / Materialized View === |
| | + | |
| | + | Views should only be used to |
| | + | |
| | + | *filter a table |
| | + | *join diferent tables |
| | + | *st_transform to change kbs |
| | + | |
| | + | <br/> |
| | + | |
| | + | The views name should the original table with action and _view or _mview. |
| | + | |
| | + | Example: ''zensus_population_by_gender_per_mun_berlin_mview'' |
| | + | |
| | + | <br/> |
| | + | |
| | + | Hint: Do not open large views with QGIS, use MView and set GIST index on geom. |
| | + | |
| | + | <br/> |
| | + | |
| | + | == Data Integrity<br/> == |
| | + | |
| | + | "Data integrity refers to maintaining and assuring the accuracy and consistency of data over its entire life-cycle." ([https://en.wikipedia.org/wiki/Data_integrity Wikipedia]) These two aspects belong to the [[Data quality|data quality]] criteria, the data in the oedb should meet. |
| | + | |
| | + | <br/> |
| | + | |
| | + | === General<br/> === |
| | + | |
| | + | *Each table should have a single auto-incremented integer column as Primary Key with the corresponding table constraint.<br/> |
| | + | *Grant all privilegs to oeuser (automatically done by the system) |
| | + | |
| | + | <br/> |
| | + | |
| | + | === Geografic Data<br/> === |
| | + | |
| | + | *Attribut name is '''geom.''' |
| | + | *Data type is '''geometry''' (or raster). |
| | + | *One of the '''Geometric Types''' is defined ([https://www.postgresql.org/docs/current/static/datatype-geometric.html https://www.postgresql.org/docs/current/static/datatype-geometric.html]) |
| | + | *The '''CRS''' is defined as EPSG ([http://spatialreference.org/ref/epsg/ http://spatialreference.org/ref/epsg/]) |
| | + | **Original data stays with the original CRS! |
| | + | **Prefered CRS of the oedb are:<br/> |
| | + | |
| | + | #WGS84 - EPSG: 4326 ([http://spatialreference.org/ref/epsg/4326/ http://spatialreference.org/ref/epsg/4326/]) |
| | + | #ETRS89 / ETRS-LAEA - EPSG: 3035 ([http://spatialreference.org/ref/epsg/3035/ http://spatialreference.org/ref/epsg/3035/]) |
| | + | |
| | + | *Spacial index '''GIST''' has to be set |
| | + | |
| | + | <br/> |
| | + | |
| | + | == Data Referencing<br/> == |
| | + | |
| | + | There are several useful attributes on a table users have to know in order to work with the contained data efficiently. Therefore, ensuring the quality of these meta data is as important as ensuring the quality of the data itself (see also [[Data quality|here]]).<br/> |
| | + | |
| | + | For these meta data the documentation open-standard Json is used ([https://en.wikipedia.org/wiki/JSON Wiki] and [http://www.json.org/ Json.org]). The documentation is separated in two major categories: |
| | + | |
| | + | #Comments on tables: Contains metadata that define several aspects for the whole table |
| | + | #Comments on rows: Store important informations on a specific row and the stored data |
| | + | |
| | + | <br/> |
| | + | |
| | + | === Comments on Tables<br/> === |
| | + | |
| | + | Comments on a table are json-dictionary as strings that describe the overall structure of the corresponding table. For every field the corresponding unit (in case of numerical values) and a description that specifies the contained data should be attached. The attribute names begin with an <u>upper case</u> and are given by the following definition of <span style="font-weight: normal"></span><span style="font-weight: normal">Database Tables. The Json meta documentation string is stored as table comment on the database table.</span> |
| | + | |
| | + | <br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | ==== Meta Documentation of Tables<br/> ==== |
| | + | |
| | + | Original Data (orig) are defined as data from one source which are not further processed (see: '''Database Schema'''). The metadata Documentation for those data sets are set as a comment on the table. Following meta data are proposed:<br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | {| style="width: 643px" cellspacing="1" cellpadding="1" |
| | + | |+ Metadata Documentation of original data on table<br/> |
| | + | |- valign="top" |
| | + | ! style="border-width: 1px medium 1px 1px; border-style: solid none solid solid; border-color: rgb(0, 0, 0) -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0.1cm 0cm 0.1cm 0.1cm; width: 198px; height: 15px" scope="col" | <div>Attribute (level 1)<br/></div> |
| | + | ! style="border-width: 1px medium 1px 1px; border-style: solid none solid solid; border-color: rgb(0, 0, 0) -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0.1cm 0cm 0.1cm 0.1cm; width: 131px" scope="col" | <div>Attribute (level 2)<br/></div> |
| | + | ! style="width: 291px; border: 1px solid rgb(0, 0, 0); padding: 0.1cm" scope="col" | <div>Description<br/></div> |
| | + | |- valign="top" |
| | + | | style="height: 15px; width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | <div>Name<br/></div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px; height: 15px" | <div><br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm; height: 15px" | <div>Original name of the data set</div> |
| | + | |- |
| | + | | style="height: 15px; width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | <div>Source</div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div><br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div><br/></div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" rowspan="2" | <div><br/></div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div>Name <br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Source Name<br/></div> |
| | + | |- valign="top" |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div>URL<br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>URL string</div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | <div>Reference date</div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div><br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Reference date of the data set.<br/></div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | <div>Date of collection</div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div><br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Date of data collection into the database.</div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | <div>Original file</div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div><br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Name of the original data file with file extension (e.g. .xls,.shp, .pdf, etc.)</div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | <div>Spatial resolution</div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div><br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Spatial resolution of the data set</div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | <div>Description</div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div><br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Short description of the data set.</div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | <div>Column</div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div><br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Metadata of all table fields / columns<br/></div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" rowspan="3" | <div><br/></div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div>Name</div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Name of Column 1<br/></div> |
| | + | |- valign="top" |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div>Description</div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>English description of Column 1</div> |
| | + | |- valign="top" |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div>Unit</div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Unit if exist e.g. (€, MWh, etc.)</div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | <div><br/></div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div>…</div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>...</div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" rowspan="3" | <div><br/></div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div>Name</div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Name of Column N</div> |
| | + | |- valign="top" |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div>Description</div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>English description of Column N</div> |
| | + | |- valign="top" |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div>Unit</div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Unit if exist e.g. (€, MWh, etc.)</div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | <div>Changes</div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div><br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Information of changes and user</div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" rowspan="4" | <div><br/></div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div>Name</div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Name of Person created or changed dataset</div> |
| | + | |- valign="top" |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div>Mail</div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>E-mail Address</div> |
| | + | |- valign="top" |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div>Date<br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Date of changes</div> |
| | + | |- valign="top" |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div>Comment<br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Comment of changes</div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | Note |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div><br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Comment of ToDo which are not done yet</div> |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | <div>Licence</div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div><br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Licence of the data set</div> |
| | + | |- |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | <br/> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | Name<br/> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | Name of Licence<br/> |
| | + | |- |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | URL |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | URL of Licence |
| | + | |- valign="top" |
| | + | | style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" | <div>Instructions for proper use<br/></div> |
| | + | | style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" | <div><br/></div> |
| | + | | style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" | <div>Instructions for proper use of Licences.</div> |
| | + | |} |
| | + | |
| | + | <br/> |
| | + | |
| | + | <u>'''[https://github.com/openego/data_processing/tree/master/data_documentation Json Example:]'''</u><br/> |
| | + | |
| | + | {| style="width: 100%" cellspacing="0" cellpadding="0" border="0" |
| | + | |- |
| | + | | <pre> |
| | + | { |
| | + | "Name": "Original name of the data set", |
| | + | "Source":[{ |
| | + | "Name": "Website of data", |
| | + | "URL": "www.website.com" }], |
| | + | "Reference date": ["2013"], |
| | + | "Date of collection": ["01.08.2013"], |
| | + | "Original file": ["346-22-5.xls"], |
| | + | "Spatial resolution": ["Germany"], |
| | + | "Description": ["Example Data (annual totals)", "Regional level: national"], |
| | + | |
| | + | "Column": [ |
| | + | {"Name":"id", |
| | + | "Description":"Unique identifier", |
| | + | "Unit":"" }, |
| | + | |
| | + | {"Name":"year", |
| | + | "Description":"Reference Year", |
| | + | "Unit":"" }, |
| | + | |
| | + | {"Name":"example_value", |
| | + | "Description": "Some important value", |
| | + | "Unit":"EUR" }], |
| | + | |
| | + | "Changes":[ |
| | + | {"Name":"Joe Nobody", |
| | + | "Mail":"joe.nobody@gmail.com (fake)", |
| | + | "Date":"16.06.2014", |
| | + | "Comment":"Created table" }, |
| | + | |
| | + | {"Name":"Joana Anybody", |
| | + | "Mail":"joana.anybody@gmail.com (fake)", |
| | + | "Date":"17.07.2014", |
| | + | "Comment":"Translated field names"}], |
| | + | |
| | + | "Note": ["Some datasets are odd -> Check numbers against another data"], |
| | + | "Licence": [{"Name":"Licence – Version 2.0 (dl-de/by-2-0", |
| | + | "URL": "http://www.govdata.de/dl-de/by-2-0]"], |
| | + | "Instructions for proper use": ["Always state licence"] |
| | + | }</pre> |
| | + | |} |
| | + | |
| | + | <br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | === Meta Documentation of data collections from several sources: === |
| | + | |
| | + | '''This section is still work in progress! Please contribute to the discussion to improve the implementation.''' |
| | + | |
| | + | <br/> |
| | + | |
| | + | In addition to the meta documentation described above, data tables (blue table in figure) which include data from several sources get a ref_id column. The ref_id links each row with a json documentation string (ref_data_json) in the database table public.reference_to_entries (green table in figure).This table also includes the ref_data_json column which links to all sources of the row to be referenced (blue). The ref_data_json string includes one jabref_entries_id for each source used. The jabref_entries_id is matched by one entries_id belonging to a source stored in the public.entries table (orange table). |
| | + | |
| | + | <br/> |
| | + | |
| | + | '''''<u>Example: ER-Model</u>'''''<br/> |
| | + | |
| | + | [[File:ERM oedb references example.png|frame|center|100px|ERM references example|alt=ERM references example]]<br/> |
| | + | |
| | + | ''<u>reference_to_entries table structure:</u>''<br/> |
| | + | |
| | + | {| style="width: 100%" cellspacing="0" cellpadding="4" |
| | + | |- valign="top" |
| | + | | style="width: 14%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''ref_id'''</font></font><br/></div> |
| | + | | style="width: 18%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''ref_data_json'''</font></font></div> |
| | + | | style="width: 20%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''schema_name'''</font></font></div> |
| | + | | style="width: 15%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''tbl_name'''</font></font></div> |
| | + | | style="width: 17%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''changed_by'''</font></font></div> |
| | + | | style="width: 17%; border: 1px solid #000000; padding: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''lastmodified'''</font></font></div> |
| | + | |- valign="top" |
| | + | | style="width: 14%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Reference ID</font></font></div> |
| | + | | style="width: 18%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Json Documentation string</font></font></div> |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Name of the schema which includes the table “tbl_name”</font></font></div> |
| | + | | style="width: 15%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Name of table with the data to be referenced</font></font></div> |
| | + | | style="width: 17%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Name of user changing or creating this reference entry. (Automatic</font></font>default setting)<br/></div> |
| | + | | style="width: 17%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Date of entry modification. (Automatic</font></font> default setting)<br/></div> |
| | + | <br/> |
| | + | |
| | + | |} |
| | + | |
| | + | Each row in the reference_to_entries table (green) contains a ref_data_json documentation string which links to the meta data in the Jabref table public.entries (orange).<br/><br/><u>'''Example:'''</u> |
| | + | |
| | + | '''Database table: '''ref_test.parameter_electrical_power_plant |
| | + | |
| | + | {| style="width: 100%" cellspacing="0" cellpadding="4" |
| | + | |- valign="top" |
| | + | | style="width: 8%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div style="text-align: justify"><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">fuel</font></font></div> |
| | + | | style="width: 25%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div style="text-align: justify"><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">type_of_generation</font></font></div> |
| | + | | style="width: 17%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div style="text-align: justify"><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">effnetto_el</font></font></div> |
| | + | | style="width: 17%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div style="text-align: justify"><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">...</font></font></div> |
| | + | | style="width: 17%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div style="text-align: justify"><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">opex_var</font></font></div> |
| | + | | style="width: 17%; border: 1px solid #000000; padding: 0.1cm" | <div style="text-align: justify"><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">ref_id</font></font></div> |
| | + | |- valign="top" |
| | + | | style="width: 8%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">coal</font></font></div> |
| | + | | style="width: 25%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">st</font></font></div> |
| | + | | style="width: 17%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''0.35'''</font></font></div> |
| | + | | style="width: 17%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">...</font></font></div> |
| | + | | style="width: 17%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''2'''</font></font></div> |
| | + | | style="width: 17%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">1</font></font></div> |
| | + | |- valign="top" |
| | + | | style="width: 8%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">...</font></font></div> |
| | + | | style="width: 25%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><br/></div> |
| | + | | style="width: 17%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><br/></div> |
| | + | | style="width: 17%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><br/></div> |
| | + | | style="width: 17%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><br/></div> |
| | + | | style="width: 17%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div><br/></div> |
| | + | |} |
| | + | |
| | + | <br/> |
| | + | |
| | + | '''''Database table: '''<u>reference_to_entries table structure:</u>'' |
| | + | |
| | + | {| style="width: 100%" cellspacing="0" cellpadding="4" |
| | + | |- valign="top" |
| | + | | style="width: 14%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''ref_id'''</font></font></div> |
| | + | | style="width: 18%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''ref_data_json'''</font></font></div> |
| | + | | style="width: 20%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''schema_name'''</font></font></div> |
| | + | | style="width: 15%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''tbl_name'''</font></font></div> |
| | + | | style="width: 17%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''changed_by'''</font></font></div> |
| | + | | style="width: 17%; border: 1px solid #000000; padding: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''lastmodified'''</font></font></div> |
| | + | |- valign="top" |
| | + | | style="width: 14%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">1</font></font></div> |
| | + | | style="width: 18%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div style="margin-bottom: 0cm"><font face="Arial, sans-serif"><font style="font-size: 8pt" size="1">{</font></font></div><div style="margin-bottom: 0cm"><font face="Arial, sans-serif"><font style="font-size: 8pt" size="1">"Name": "Collection of electrical power plant parameter",</font></font></div><div><font face="Arial, sans-serif"><font style="font-size: 8pt" size="1">"Discription": "Technical parameter of confentional electrical power plants '''…'''</font></font></div> |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">ref_test</font></font></div> |
| | + | | style="width: 15%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">parameter_electrical_power_plant</font></font></div> |
| | + | | style="width: 17%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">user_1</font></font></div> |
| | + | | style="width: 17%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">2016-03-17 15:37:24.538213</font></font></div> |
| | + | |} |
| | + | |
| | + | <u>'''Json'''</u>''<u><span style="font-weight: normal"></span></u>''<u>'''Example:'''</u> |
| | + | |
| | + | {| style="width: 100%" cellspacing="0" cellpadding="0" border="0" |
| | + | |- |
| | + | | |
| | + | <pre> |
| | + | { |
| | + | "Name": ["Collection of electrical power plant parameter"], |
| | + | "Description":["Technical parameter of conventional electrical power plants "], |
| | + | "Column": [{ |
| | + | "effnetto_el":{"jabref_entries_id": 1, |
| | + | "Description":"Electrical net efficiency}, |
| | + | |
| | + | "opex_var": {"jabref_entries_id": 2, |
| | + | "Description":"Variable operational expenditure"} }], |
| | + | |
| | + | "Note":["Short note or comment to this entry"] |
| | + | }</pre><br/> |
| | + | |
| | + | |} |
| | + | |
| | + | '''Note:''' The general meta information like units are given meta documentation of the table. |
| | + | |
| | + | The metadata [https://en.wikipedia.org/wiki/BibTeX BibTeX standard] from [http://www.jabref.org JabRef] is used for the Data Referencing in the table public.entries. |
| | + | |
| | + | <br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | === Comments on Rows<br/> === |
| | + | |
| | + | '''This section is still work in progress! Please contribute to the discussion to improve the implementation.''' |
| | + | |
| | + | <br/> |
| | + | |
| | + | The comments on a row aim to enhance the reproducabilty of data that is present in the database by stating the underlying data that was used to compute this row as well as the applied computational methods.<br/> |
| | + | |
| | + | During these processes some kinds of uncertainities might occur as well as the decissions (assumtions) that were made to deal with them. Examplatory, some values might be missing amid this row and a linear development during this period was assumed to fix this gap. Each row has to be annotated by a json dictionary that must contain the following fields:<br/> |
| | + | |
| | + | ''<u>Json documentation string structure on row:</u>''<br/> |
| | + | |
| | + | {| style="width: 100%" cellspacing="0" cellpadding="4" |
| | + | |+ Metadata Documentation of data on rows |
| | + | |- valign="top" |
| | + | | style="width: 22%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''Attribute (level 1)'''</font></font><br/></div> |
| | + | | style="width: 20%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''Attribute (level 2)'''</font></font><br/></div> |
| | + | | style="width: 19%; border-top: 1px solid #000000; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0.1cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''Attribute (level 3)'''</font></font></div> |
| | + | | style="width: 39%; border: 1px solid #000000; padding: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">'''Description'''</font></font></div> |
| | + | |- valign="top" |
| | + | | style="height: 15px; width: 22%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div class="western"><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Name</font></font></div> |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div class="western"></div> |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><br/></div> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Name of the table to be referenced</font></font></div> |
| | + | |- |
| | + | | style="height: 15px; width: 22%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | Origin<br/> |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <br/> |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <br/> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | Link or textual description of the data set this row origins from<br/> |
| | + | |- |
| | + | | style="height: 15px; width: 22%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | Assumption<br/> |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <br/> |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <br/> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | A list of dictionaries. Each dictionary describes an assumption and annotates the affected rows<br/> |
| | + | |- |
| | + | | style="height: 15px; width: 22%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <br/> |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | begin<br/> |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <br/> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | First column affected by the assumption<br/> |
| | + | |- |
| | + | | style="height: 15px; width: 22%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | end |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | Last column affected by the assumption |
| | + | |- |
| | + | | style="height: 15px; width: 22%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <br/> |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | type<br/> |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <br/> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | Type of the problem that had to be solved. Each type requires one or more additional keys in this dictionary. Possible types and their required additional keys are: gap, multiplicity<br/> |
| | + | |- |
| | + | | style="height: 15px; width: 22%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | solution |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | Method that was used to generate date to fix this problem (e.g. linear interpolation) |
| | + | |- |
| | + | | style="height: 15px; width: 22%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | values |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | [Only if type is multiplicity] Possible Values that could have been used |
| | + | |- valign="top" |
| | + | | style="height: 15px; width: 22%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div class="western"><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Discription</font></font><br/></div> |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div class="western"></div> |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><br/></div> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Short description of the table</font></font></div> |
| | + | |- valign="top" |
| | + | | style="height: 15px; width: 22%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div class="western"><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2"><span style="background: transparent">Column</span></font></font></div> |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div class="western"></div> |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><br/></div> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Columns which need to be referenced</font></font></div> |
| | + | |- valign="top" |
| | + | | style="height: 15px; width: 22%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" rowspan="6" | <div style="text-align: center" class="western"></div> |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div style="text-align: left" class="western"><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2"><column name 1></font></font></div> |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><br/></div> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Column name 1, (original column name and spelling)</font></font></div> |
| | + | |- valign="top" |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" rowspan="2" | <div style="text-align: center" class="western"></div> |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">jabref_entries_id</font></font></div> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Jabref entries id of Literature entry</font></font></div> |
| | + | |- valign="top" |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Description</font></font></div> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Short description</font></font></div> |
| | + | |- valign="top" |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div style="text-align: left" class="western"><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2"><</font></font><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">column</font></font><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">name</font></font><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">2</font></font><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">></font></font></div> |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><br/></div> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div style="text-align: left" class="western"><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Column name 2, (original column name and spelling)</font></font></div> |
| | + | |- valign="top" |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" rowspan="2" | <div style="text-align: center" class="western"></div> |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">jabref_entries_id</font></font></div> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Jabref entries id of Literature entry</font></font></div> |
| | + | |- valign="top" |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Description</font></font></div> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Short description</font></font></div> |
| | + | |- valign="top" |
| | + | | style="height: 14px; width: 22%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div style="text-align: left" class="western"><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Note</font></font></div> |
| | + | | style="width: 20%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div style="text-align: left" class="western"></div> |
| | + | | style="width: 19%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: none; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0cm" | <div><br/></div> |
| | + | | style="width: 39%; border-top: none; border-bottom: 1px solid #000000; border-left: 1px solid #000000; border-right: 1px solid #000000; padding-top: 0cm; padding-bottom: 0.1cm; padding-left: 0.1cm; padding-right: 0.1cm" | <div><font face="Arial, sans-serif"><font style="font-size: 10pt" size="2">Note or comment to this entry</font></font></div> |
| | + | |} |
| | + | |
| | + | <br/> |
| | + | |
| | + | <br/> |
| | | | |
| | + | <br/><br/>An examplatory dictionary:<br/> |
| | | | |
| − | All abreviations have to be documentated (in the [[Category:Glossary|Glossary]])!
| + | {| style="width: 100%" cellspacing="0" cellpadding="0" border="0" |
| | + | |- |
| | + | | <pre> |
| | + | { |
| | + | "origin":"https://data.openmod-initiative.org/data/oedb/orig_db/table |
| | + | "method":"https://github.com/openego/data_processing/blob/master/calc_ego_substation/Voronoi_ehv.sql" |
| | + | "assumptions": |
| | + | [ |
| | + | { |
| | + | "type": "gap" |
| | + | "begin": "step_15" |
| | + | "end": "step_34" |
| | + | "solution": "linear_interpolation" |
| | + | } |
| | + | ] |
| | + | } |
| | + | </pre> |
| | + | |} |
The following database rules explain the basic principles of the database called oedb, which will become a part of the openmod internet presence. For further details see also here.
"Data integrity refers to maintaining and assuring the accuracy and consistency of data over its entire life-cycle." (Wikipedia) These two aspects belong to the data quality criteria, the data in the oedb should meet.
There are several useful attributes on a table users have to know in order to work with the contained data efficiently. Therefore, ensuring the quality of these meta data is as important as ensuring the quality of the data itself (see also here).
Comments on a table are json-dictionary as strings that describe the overall structure of the corresponding table. For every field the corresponding unit (in case of numerical values) and a description that specifies the contained data should be attached. The attribute names begin with an upper case and are given by the following definition of Database Tables. The Json meta documentation string is stored as table comment on the database table.
Original Data (orig) are defined as data from one source which are not further processed (see: Database Schema). The metadata Documentation for those data sets are set as a comment on the table. Following meta data are proposed:
In addition to the meta documentation described above, data tables (blue table in figure) which include data from several sources get a ref_id column. The ref_id links each row with a json documentation string (ref_data_json) in the database table public.reference_to_entries (green table in figure).This table also includes the ref_data_json column which links to all sources of the row to be referenced (blue). The ref_data_json string includes one jabref_entries_id for each source used. The jabref_entries_id is matched by one entries_id belonging to a source stored in the public.entries table (orange table).
Each row in the reference_to_entries table (green) contains a ref_data_json documentation string which links to the meta data in the Jabref table public.entries (orange).
Example:
The comments on a row aim to enhance the reproducabilty of data that is present in the database by stating the underlying data that was used to compute this row as well as the applied computational methods.
During these processes some kinds of uncertainities might occur as well as the decissions (assumtions) that were made to deal with them. Examplatory, some values might be missing amid this row and a linear development during this period was assumed to fix this gap. Each row has to be annotated by a json dictionary that must contain the following fields:
