public:metadata
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
public:metadata [2017/11/16 07:02] penhleak [Metadata: Dataset (both spatial and non-spatial) - Version 1] |
public:metadata [2020/10/09 02:55] (current) mchung [Guidelines for creating accurate metadata] |
||
|---|---|---|---|
| Line 8: | Line 8: | ||
| ==== What this guide teaches ==== | ==== What this guide teaches ==== | ||
| - | * What is medata data, and why it is important? | + | * What is metadata, and why it is important? |
| - | * Guidelines for creating metadata | + | * Guidelines for creating an accurate metadata |
| * Open Development metadata templates | * Open Development metadata templates | ||
| Line 18: | Line 18: | ||
| Without having to tear the wrapping papers and open the box, a label with written note attached can tell you what they are going to get. | Without having to tear the wrapping papers and open the box, a label with written note attached can tell you what they are going to get. | ||
| - | Similarly, for CKAN purposes, data is published in units called “datasets”. A dataset is a parcel of data - for example, it could be the crime statistics for a region, the spending figures for a government department, or temperature readings from various weather stations or a reference document. | + | A carefully wrapped present with out a label might add excitement for the gift recipient, but data without a metadata is not usable. Data is simply number and figures. Data doesn’t mean anything without a description, a metadata. |
| + | |||
| + | For CKAN purposes, data is published in units called “datasets”. A dataset is a parcel of data - for example, it could be the crime statistics for a region, the spending figures for a government department, or temperature readings from various weather stations or a reference document. | ||
| A dataset contains two things: | A dataset contains two things: | ||
| Line 28: | Line 30: | ||
| Example: [[https://opendevelopmentmekong.net/dataset/?id=hydro-basins-level-6-greater-mekong-subregion-laos-myanmar-thailand-vietnam-cambodia&search_query=P3M9aHlkcm9iYXNpbiZ0eXBlPWRhdGFzZXQmcGFnZT0w|Hydrobasins level 6 dataset on OD Mekong]] | Example: [[https://opendevelopmentmekong.net/dataset/?id=hydro-basins-level-6-greater-mekong-subregion-laos-myanmar-thailand-vietnam-cambodia&search_query=P3M9aHlkcm9iYXNpbiZ0eXBlPWRhdGFzZXQmcGFnZT0w|Hydrobasins level 6 dataset on OD Mekong]] | ||
| - | {{ :public:hydrobasin_data.png?nolink&600 |}} | + | {{ :hydro_basin_level_6_mekong.png?nolink&600 |}} |
| Metadata provides important context about an informational asset’s source and manner of creation, as well as in what applications or environments the asset is relevant. | Metadata provides important context about an informational asset’s source and manner of creation, as well as in what applications or environments the asset is relevant. | ||
| Line 44: | Line 46: | ||
| **How may we create an accurate and useful metadata when the information it is describing might be flawed?** | **How may we create an accurate and useful metadata when the information it is describing might be flawed?** | ||
| - | We aim to produce, to the best of our ability, an accurate metadata by describing the extent of our knowledge about a asset/resource. It should clearly state what is known about the resource and what is not known or problematic. Metadata changes when the asset itself or knowledge about its condition changes. | + | We aim to produce, to the best of our ability, an accurate metadata by describing the extent of our knowledge about the asset/resource. A good metadata should clearly state what is known about the resource and what is not known or problematic. Metadata changes when the asset itself or knowledge about its condition changes. |
| - | + | ||
| - | If information is missing or inconsistent, describe the known inconsistencies or gaps instead of disregarding the resource. Mention any steps being taken to address these issues, along with an expected timeline. | + | |
| + | If information is missing or inconsistent, describe the known inconsistencies or gaps instead of disregarding the resource. Mention any steps being taken to address these issues, along with an expected timeline. **[THIS INSTRUCTION IS UNDER REVIEW] | ||
| + | ** | ||
| ==== Open Development Platform metadata templates ==== | ==== Open Development Platform metadata templates ==== | ||
| - | On the Datahub 4 different types of datasets, each requires its own metadata template, are currently stored/administered: | + | For each different type of data, there are specific terms that relate to that type of data. On the Datahub 4 different types of datasets, each requires its own metadata template, are currently stored/administered: |
| * Dataset (both spatial and non-spatial) | * Dataset (both spatial and non-spatial) | ||
| * Library records | * Library records | ||
| * Law records | * Law records | ||
| - | * Agreement records (for contracts - metadata template is being developed) | + | * Agreement records (for contracts) |
| - | These metadata templates are developed by adapting and enhancing the standard CKAN's metadata template. Each template contains metadata fields common for all dataset types on CKAN and a set of fields that are only applicable to the dataset type. For example, metadata about a research report (Library records) will have information about author(s) and publishers (s); metadata for laws and policies (Law records) will instead have information about the drafting agency, issuing agency, and promulgation date etc. | + | These metadata templates were developed by adapting and enhancing the standard CKAN's metadata template. Each template contains metadata fields common for all dataset types on CKAN and a set of fields that are only applicable to the dataset type. For example, metadata about a research report (Library records) will have information about author(s) and publishers (s); metadata for laws and policies (Law records) will instead have information about the drafting agency, issuing agency, and promulgation date etc. |
| The templates below outline information that should be included and offer instruction for each metadata field. | The templates below outline information that should be included and offer instruction for each metadata field. | ||
| - | <WRAP center round info 90%> | + | ==== Metadata for dataset (both spatial and non-spatial) ==== |
| - | * Fields marked with * are mandatory | + | |
| - | * Fields marked with [ML] are multilingual | + | |
| - | * Fields marked with [M] can have more than 1 value | + | |
| - | * Fields with contents being <del>striked through</del> are marked for removal | + | |
| - | </WRAP> | + | |
| - | + | ||
| - | ^ Label ^ Field Name (API) ^ Definition ^ Guidelines ^ Example ^ | + | |
| - | | Title * [ML] | title,title_translated | Name given to the dataset. | | | | + | |
| - | | Description [ML] | notes,notes_translated | Short description explaining the content and its origins. | | | | + | |
| - | | Topics * [M] | taxonomy | e.g. economy, mental health, government | | Labor | | + | |
| - | | License * | odm_license | The license that applies to published dataset. | License definitions and additional information can be found at http://opendefinition.org/ | | | + | |
| - | | Copyright * | odm_copyright | | Select 'Yes', 'No', 'Unclear copyright' or 'To be determined' about the copyright of the dataset. If copyright of any type is present, describe further in Access and User Constraints. | | | + | |
| - | | Access and use constraints [ML] | odm_access_and_use_constraints | A few sentences describing legal considerations for people who access the website and/or use its contents | | | | + | |
| - | | Organization * | owner_org | | | Open Development Mekong | | + | |
| - | | Visibility | | | | Private | | + | |
| - | | Version | version | Dataset's version (eg. 1.0) | | | | + | |
| - | | Contact [ML] | odm_contact | Contact information for the individual or organization that is responsible for or most knowledgeable about the dataset. This could be the author of a report, the contact information for the relevant department of an organization that produced a report, or the data analyst, mapper or researcher that produced a dataset or report. | | | | + | |
| - | | Language * [M] | odm_language | Language(s) of the dataset, including resources within dataset | Lowercase list of ISO 639-1 language name abbreviations, separated by comma. Most common: en (English), km (Khmer), lo (Lao), my (Burmese), th (Thai), vi (Vietnamese) | en, km | | + | |
| - | | Date created * | odm_date_created | Date the dataset was first published by its creator. | Write as YYYY-MM-DD. If an element is unknown, write a 0 in place of the digit. | 2011-12-00 | | + | |
| - | | Date uploaded * | odm_date_uploaded | Date the dataset was first uploaded to the OD CKAN database. | Write as YYYY-MM-DD. If an element is unknown, write a 0 in place of the digit. | 2013-00-00 | | + | |
| - | | Date modified | odm_date_modified | Date a new version or update of the dataset was uploaded to the OD CKAN database. | Write as YYYY-MM-DD. If an element is unknown, write a 0 in place of the digit. If no new version has been uploaded, then write NA. | NA | | + | |
| - | | Temporal range | odm_temporal_range | The period of time for which the dataset is relevant (i.e. 2011-01-01:2011-12-31). | Write as YYYY-MM-DD: YYYY-MM-DD. If a date element is unknown, write a 0s in its place. If the resource covers an entire calendar year, the period should begin with the first day of the year and end with the last. | 2011-01-01:2011-12-31 | | + | |
| - | | Geographic area (spatial range) * [M] | odm_spatial_range | The geographic area that the dataset is relevant to (i.e. Cambodia, Laos). | Provide all countries that the resource is relevant to, separated by a comma. | Cambodia, Laos, Myanmar, Thailand, Vietnam (if the resource is relevant to all countries in the Mekong region) | | + | |
| - | | Accuracy | odm_accuracy | Details on the level of accuracy of the dataset and any existing issues. | Accuracy can refer to the spatial resolution of a satellite image, disagreements others have expressed about the resource's contents, any other references that contain contrary information, and other issues. Should be written in plain language, with numbers when appropriate. If you are not aware of any problems, write: ‘There are no known issues with accuracy.’ If the resource or some of its content describes something that is constantly changing, add: ‘Information subject to change’ and describe the nature of the change, if possible. | Data is given at the provincial level. There are no known issues with accuracy. | | + | |
| - | | Logical consistency | odm_logical_consistency | Issues with logical consistency in the dataset and the steps, if any, being taken to validate its content. | Description in a few sentences. Can be a mix of numbers and words. If you are not aware of any problems, write: ‘There are no known issues with logical consistency.’ | Concessions A and B overlap 50 hectares. We anticipate conducting field validation of these concessions by 2014-10-31. | | + | |
| - | | Completeness | odm_completeness | Brief description of the level of completeness of the dataset's contents and the steps, if any, being taken to make the dataset more complete. | Description in a few sentences. Can be a mix of numbers and words. If you are not aware of any problems, write: ‘There are no known issues with completeness.’ | Locations are included for 30 of 50 concessions in the dataset. We are in the process of acquiring official government documentation on the remaining 20. | | + | |
| - | | Process(es)* | odm_process | The steps taken to acquire, aggregate, or transform any of the resources in the dataset. | Short description, written in plain language. Include any details regarding updates occurring to the dataset. | Available data were provided in SHP file format by The Atlas of Cambodia. The data were then exported in CSV and GEOJSON format by Open Development Cambodia using QGIS. | | + | |
| - | | Source(s)* | odm_source | Ordered citations for all information sources that went into producing the dataset. | Use a standard citation style or at least include the following information: Organization Name. "Title of dataset." File type (CSV, JSON, etc.). Accessed Month ##, year. link. | World Bank. "Annual GDP Growth (%)." XLS. Accessed November 31, 2014. http://www.worldbank.org/en/publication/global-economic-prospects/data?variable=NYGDPMKTPKDZ®ion=EAP | | + | |
| - | | Metadata reference information | odm_metadata_reference_information | Information about how up-to-date the metadata is and who is responsible for maintaining it. | Write as: Metadata last updated on YYYY-MM-DD. For inquiries, see contact. | | | + | |
| - | | Attributes | odm_attributes | Details about the information content of the dataset. | List of attributes, who or which organization defined them, and what they describe (including any units of measurement in parentheses). Write as: Attribute Name / Organization : Attribute Definition | Land area (sq. km) / World Bank: Land area is a country's total area, excluding area under inland water bodies, national claims to continental shelf, and exclusive economic zones. In most cases the definition of inland water bodies includes major rivers and lakes. | | + | |
| + | [[public:geospatial_metadata|public:geospatial_metadata]] | ||
| + | |||
| ==== Metadata template for library publications ==== | ==== Metadata template for library publications ==== | ||
| - | <WRAP center round info 90%> | + | [[public:library_metadata|public:library_metadata]] |
| - | * Fields marked with * are mandatory | + | |
| - | * Fields marked with [ML] are multilingual | + | |
| - | * Fields marked with [M] can have more than 1 value | + | |
| - | * Fields with contents being <del>striked through</del> are marked for removal | + | |
| - | </WRAP> | + | |
| - | Following template have been implemented on CKAN for Librarians to continue populating the Library database with new records: | + | ==== Metadata template for law and policy documents ==== |
| - | ^ MARC21 field ^ Field label ^ Field name (API) ^ Definition ^ Field type ^ Example ^ | + | [[public:laws_metadata|public:laws_metadata]] |
| - | | | Document type * | document_type | | | Advocacy and promotional materials. | | + | |
| - | | | Language of document * [M] | odm_language | Language(s) of the dataset, including resources within dataset | | English, Khmer, Chinese | | + | |
| - | | 245 | Formal full title [ML] | title,title_translated | Main title | String | | | + | |
| - | | 246 | Short title (alternative/varying form of title) [ML] | marc21_246 | Parallel title or translation | String | Khmer title if have both | | + | |
| - | | | Topics * [M] | taxonomy | e.g. economy, mental health, government | | | | + | |
| - | | 520 | Short summary (contents) [ML] | notes,notes_translated | Abstract or summary of book or article | String | | | + | |
| - | | | Geographical area (spatial range) * [M] | odm_spatial_range | The geographic area that the dataset is relevant to (i.e. Cambodia, Laos) | | | | + | |
| - | | | Copyright | odm_copyright | | | | | + | |
| - | | | Access and use constraints [ML] | odm_access_and_use_constraints | A few sentences describing legal considerations for people who access the website and/or use its contents. | | | | + | |
| - | | 250 | Version / Edition * | marc21_250 | Version of publication | String | 2nd edition | | + | |
| - | | | Organization * | owner_org | | | Open Development Cambodia | | + | |
| - | | | Visibility | | | | Private | | + | |
| - | | | Date uploaded * | odm_date_uploaded | Date a new version or update of the dataset was uploaded to the OD CKAN database | | 2015-12-25 | | + | |
| - | | | License | odm_license | The license that applies to the library publication | | CC BY-NC-ND 4.0 | | + | |
| - | | | Contact [ML] | odm_contact | Contact information for the individual or organization that is responsible for or most knowledgeable about the dataset. This could be the author of a report, the contact information for the relevant department of an organization that produced a report, or the data analyst, mapper or researcher that produced a dataset or report. | | Thompson, Rebeca / Asian Development Bank / +855-12-123-456 / rthompson@e-mail.com | | + | |
| - | | 100 | Author (individual) | marc21_100 | Main Entry-Personal Name (author) | String | Barney, Keith | | + | |
| - | | 110 | Author (corporate) | marc21_110 | Main Entry-Corporate Name (corporation) or title of journal | String | Asian Development Bank | | + | |
| - | | 700 | Co-author (individual) [M] | marc21_700 | Personal name (co-author), more than one author | String | Williamson, Andrew | | + | |
| - | | 710 | Co-author (corporate) | marc21_710 | Corporate name, more than one corporation. | String | Cambodia. Ministry of Environment | | + | |
| - | | 020 | ISBN number | marc21_020 | The International Standard Book Number (ISBN) is a unique numeric commercial book identifier based upon the 10 or 13-digit Standard Book Numbering (SBN). | String | 978-981-4311-87-8 or 0-1223-4023-1 | | + | |
| - | | 022 | ISSN number | marc21_022 | International Standard Serial Number (ISSN) a unique numeric commercial serial identifier based upon the 8-digit Standard Serial Number (SSN) | String | 2049-3630 | | + | |
| - | | 260$a | Publication place [ML] | marc21_260a | Place of publisher | String | Oxford | | + | |
| - | | 260$b | Publisher [ML] | marc21_260b | Name of publishing organization (full name) | String | Oxford University Press | | + | |
| - | | 260$c | Publication date | marc21_260c | Date published | Date | 2012 | | + | |
| - | | 300 | Pagination [ML] | marc21_300 | Physical description (pagination) | String | 123 | | + | |
| - | | 500 | General note [ML] | marc21_500 | General note | String | Published in English and Khmer | | + | |
| - | ==== Metadata template for laws, policies and agreements ==== | + | ==== Metadata for agreement documents (contracts) ==== |
| - | ^ Label ^ Field name (API) ^ Definition ^ Guidelines ^ Example ^ | + | [[public:agreement_metadata|public:agreement_metadata]] |
| - | | Document type | odm_document_type | | Select an appropriate document type from the drop-down list. | | | + | |
| - | | Document reference # | odm_document_number | Document, issue, or series number. | | | | + | |
| - | | Language of document * [M] | odm_language | | | | | + | |
| - | | Formal full title [ML] | title,title_translated | Full title from the document | (need guideline) | All laws in Cambodia start as "Law on....... " | | + | |
| - | | Alternative/short title | odm_short_title | Commonly used label, e.g. Cambodia Labor Law. | | Cambodia Labor Law | | + | |
| - | | Topics * [M] | taxonomy | Describe general purpose and scope. | Assign ODI categories to the document. | | | + | |
| - | | Short summary [ML] | notes,notes_translated | | Describe general purpose and scope, preamble will often provide a useful statement of objective. | | | + | |
| - | | Primary policy reference point | odm_laws_primary_policy_reference_point | References are generally in the preamble or opening sections of a legal authority as the legitimacy of the document is derived from the source it references. | This is the objective. Such references are generally in the preamble or opening sections of a legal authority as the legitimacy of the document is derived from the source it references) | Decrees and proclamations will often reference a law that they are implementing, and laws will sometimes reference a constitutional provision or a treaty that they are giving expression to. While it may be difficult to identify the primary legal authority being referenced (more than one constitutional provision may be referenced by a law). | | + | |
| - | | Geographic area (spatial range) * [M] | odm_spatial_range | | | | | + | |
| - | | Organization * | owner_org | | | | | + | |
| - | | Visibility | | | | | | + | |
| - | | License | odm_license | | | | | + | |
| - | | Copyright | odm_copyright | | | | | + | |
| - | | Access and use constraints [ML] | odm_access_and_use_constraints | A few sentences describing legal considerations for people who access the website and/or use its contents. | | | | + | |
| - | | Status * | odm_laws_status | Hierarchical status of agreement, law, decree or other legal policy. | In Cambodia this would be one of the following: Constitution, International Covenant or Treaty, Chbab/Statute, Kram/Kret/Royal Decree, Anukret/Sub-Decree, Prakas/Proclamation, Sechkdei Samrech/Decision, Sarachor/Circular, Deka/Provincial Ordinance – and other countries should reflect a similar structure though perhaps with different labels. | | | + | |
| - | | Version date (of draft) | odm_laws_version_date | Date the version of draft law was created. | | | | + | |
| - | | Adoption date/Promulgation date/Signing date| odm_promulgation_date | Date the law was officially authorized. | | | | + | |
| - | | Effective date | odm_effective_date | Date the law is to take effect. | | | | + | |
| - | | Application date | odm_application_date | | | | | + | |
| - | | Previous legal document | odm_laws_previous_legal_document | | Does this law replace, amend or supplement previous law? Select a law from a drop-down list. | | | + | |
| - | | Short notes of change [ML] | odm_laws_previous_changes_notes | Describe what changed. | Describe what changed | | | + | |
| - | | Relationship to other legal docs | odm_laws_relationship_type | | User can add more than one. | | | + | |
| - | | Associated document | odm_laws_relationship_target | | User can add more than one, same as above. | | | + | |
| - | | Publication reference | odm_laws_official_publication_reference | The official gazette or other official promulgation of policy, referencing issue #, date and page | | | | + | |
| - | | Links to source | odm_laws_source | Officials URLs where the document is made available. | | | | + | |
| - | | Contact [ML] | odm_contact | Contact information for the individual or organization that is responsible for or most knowledgeable about the document. | | Thompson, Rebeca / Asian Development Bank / +855-12-123-456 / rthompson@e-mail.com | | + | |
| - | | Drafting agency [ML] | odm_laws_drafting_agency | | | | | + | |
| - | | Technical assistance for drafting | odm_laws_draft_assistance | | | | | + | |
| - | | Agency providing technical assistance [ML] | odm_laws_agency_technical_assistance | | | | | + | |
| - | | Technical assistance funding agency [ML] | odm_laws_technical_assistance_funding_agency| | | | | + | |
| - | | Issuing agency/parties [ML] | odm_laws_issuing_agency_parties | | | | | + | |
| - | | Implementing agencies [ML] | odm_laws_implementing_agencies | | | | | + | |
| - | | Notes [ML] | odm_laws_notes | Add any notes to this document. | | | | + | |
| - | ==== Other metadata fields ==== | ||
| Other metadata fields exposed by the CKAN API: | Other metadata fields exposed by the CKAN API: | ||
public/metadata.1510815743.txt.gz · Last modified: 2020/06/23 15:03 (external edit)
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
