|
|
Line 1: |
Line 1: |
| + | |
| {{GlossaryTermTemp | | {{GlossaryTermTemp |
| |SubtermOf=Database | | |SubtermOf=Database |
− | }} | + | }} 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/> |
− | 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/> | + | |
| | | |
| + | <br/> |
| | | |
| = Open Data<br/> = | | = Open Data<br/> = |
Line 12: |
Line 13: |
| More Information can be found on [[Choosing a license|Open Licenses.]] Additional to the the Project Open Power System Data is covering this topic on [http://open-power-system-data.org/legal OPSD - Legal]. | | More Information can be found on [[Choosing a license|Open Licenses.]] Additional to the the Project Open Power System Data is covering this topic on [http://open-power-system-data.org/legal OPSD - Legal]. |
| | | |
| + | <br/> |
| | | |
| = Data Documentation<br/> = | | = Data Documentation<br/> = |
| | | |
| *All data included in the databases has be documented! On this wiki page you learn how to do so<br/> | | *All data included in the databases has be documented! On this wiki page you learn how to do so<br/> |
− | *All abreviations have to be documentated in the [[Category:Glossary|Glossary]] of the openmod wiki<br/> | + | *All abreviations have to be documentated in the of the openmod wiki<br/> |
| | | |
| = Naming of Data<br/> = | | = Naming of Data<br/> = |
Line 25: |
Line 27: |
| == Database Name<br/> == | | == Database Name<br/> == |
| | | |
− | *The name of the database is <br/> | + | *The name of the database is<br/> |
| | | |
| + | <br/> |
| | | |
| == Database Schema<br/> == | | == Database Schema<br/> == |
Line 46: |
Line 49: |
| <br/> | | <br/> |
| | | |
− | *<u></u>Special schemas:<br/> | + | *Special schemas:<br/> |
| **model_draft<br/> | | **model_draft<br/> |
| ***model data<br/> | | ***model data<br/> |
| ***has no version control | | ***has no version control |
| | | |
− | **reference<br/> | + | * |
| + | *reference<br/> |
| ***sources<br/> | | ***sources<br/> |
| ***literature<br/> | | ***literature<br/> |
Line 57: |
Line 61: |
| Further schema categories or changes can be [https://github.com/openego/oeplatform/issues discussed on GitHub]. There is a whitelist.<br/> | | Further schema categories or changes can be [https://github.com/openego/oeplatform/issues discussed on GitHub]. There is a whitelist.<br/> |
| | | |
| + | <br/> |
| | | |
| == Database Table == | | == Database Table == |
Line 77: |
Line 82: |
| Example: ''zensus_population_by_gender_per_mun''<br/><br/> | | Example: ''zensus_population_by_gender_per_mun''<br/><br/> |
| | | |
− | Remember to put your abbreviations in the [[Category:Glossary|Glossary.]] | + | Remember to put your abbreviations in the |
| | | |
| = Data Integrity<br/> = | | = Data Integrity<br/> = |
Line 92: |
Line 97: |
| <br/> | | <br/> |
| | | |
− | | + | <br/> |
| | | |
| == Geografic Data<br/> == | | == Geografic Data<br/> == |
Line 108: |
Line 113: |
| *Spacial index '''GIST''' has to be set | | *Spacial index '''GIST''' has to be set |
| | | |
− | | + | <br/> |
| | | |
| = Data Referencing<br/> = | | = Data Referencing<br/> = |
Line 348: |
Line 353: |
| | | |
| 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/> | | 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/> |
− |
| |
− | ''<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>
| |
− | |- 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></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/>
| |
− |
| |
| <u>'''Example:'''</u> | | <u>'''Example:'''</u> |
| | | |
Line 493: |
Line 440: |
| 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/> | | 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: | + | 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/> |
| | | |
− | *origin: Link or textual description of the data set this row origins from.<br/>
| + | ''<u>Json documentation string structure on row:</u>''<br/> |
− | *method: Method used to calculate this row from above origin (e.g. Link to a python script)<br/>
| + | |
− | *assumption: A list of dictionaries. Each dictionary describes an assumption and annotates the affected rows.<br/>
| + | |
− | **begin: First column affected by the assumption<br/>
| + | |
− | **end: Last column affected by the assumption<br/>
| + | |
− | **type: 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:<br/>
| + | |
− | ***gap: A not all fields could be calculated and/or filled
| + | |
− | ****solution: Method that was used to generate date to fill this gap (e.g. linear interpolation)
| + | |
| | | |
− | *multiplicity: A field could be filled by several values
| + | {| style="width: 100%" cellspacing="0" cellpadding="4" |
− | *solution: Method that was used to select one value (e.g. Minimum)
| + | |+ Metadata Documentation of data on rows |
− | *values: Possible Values that could have been used
| + | |- 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/> | | <br/><br/>An examplatory dictionary:<br/> |
"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: