Skip to content

Commit

Permalink
Update metadata_management.md (#777)
Browse files Browse the repository at this point in the history
Update distinction between metadata schema and checklist, according to the machine actionability page.
  • Loading branch information
floradanna authored Dec 13, 2021
1 parent 757f7b0 commit 6e94b29
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions pages/your_tasks/metadata_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Due to the large variety of experiments, techniques and collaborative studies th

* Both the study- and data-level documentation must be generated as early as possible in the research process and also maintained, in order to be accurate and complete

* Documentation is also required when publishing your data. General-purpose repositories usually require only study-level documentation, while discipline-specific repositories generally require both study-level and data-level documentation. Importantly, repositories often accept data and documentation in a very strict format: they can require a predefined set of attributes or fields (metadata scheme) to be filled, ontology terms to be used, specific data model (e.g., ISA model, MAGE-TAB) to be adopted. We recommend familiarizing yourself with the requirements of the repositories that could be appropriate for publishing your data already at the beginning of the project, so that you can start documenting and formatting your data accordingly as early as possible.
* Documentation is also required when publishing your data. General-purpose repositories usually require only study-level documentation, while discipline-specific repositories generally require both study-level and data-level documentation. Importantly, repositories often accept data and documentation in a very strict format: they can require a predefined set of attributes or fields (metadata checklists) to be filled, ontology terms to be used, specific (meta)data schemas (e.g., ISA model, MAGE-TAB) to be adopted. We recommend familiarizing yourself with the requirements of the repositories that could be appropriate for publishing your data already at the beginning of the project, so that you can start documenting and formatting your data accordingly as early as possible.

* Make sure the documentation is kept close to the data, so that nobody will be exposed to the data without being able to find the documentation.

Expand Down Expand Up @@ -63,15 +63,15 @@ Due to the large variety of experiments, techniques and collaborative studies th
* Data dictionary ([see an example](https://webdav-r3lab.uni.lu/public/elixir/templates/Data_dictionary_example.xlsx))
* Data list

Each of these files can be made in several formats depending on the features available in your data documentation tool, your needs or skills. Machine readable formats (such as XML, JSON, CSV, RDF, HTML) are preferred to non-machine-readable ones (.txt, xls, pdf). Also non-proprietary formats are preferred over proprietary ones.
Each of these files can be made in several formats depending on the features available in your data documentation tool, your needs or skills. Machine-readable or -actionable formats (such as .xml, .json, .csv, .rdf) are preferred to non-machine-readable ones (.txt, .xls, .pdf). Also non-proprietary formats are preferred over proprietary ones.

* Highly structured data documentation is called **metadata**. Generating metadata in **machine-readable format** makes your data more FAIR . Metadata provides structured and searchable information so that a user can find existing data, evaluate its reusability and cite it.
* Highly structured data documentation is called **metadata**. Generating metadata in machine-readable or -actionable format makes your data more FAIR . Metadata provides structured and searchable information so that a user can find existing data, evaluate its reusability and cite it.

* It is good practice to use international standard metadata schemes to describe your data. A metadata schema is a fixed set of attributes (elements or fields) about the data that needs to be provided. Some attributes are mandatory, some are only recommended or optional. International standard metadata schemes are developed by and accepted as standards by communities. There are many standard metadata schemes, some generic, while others discipline-specific. See the paragraph about [how to find standard metadata schemes.](https://rdmkit.elixir-europe.org/metadata_management.html#how-do-you-find-appropriate-standard-metadata-for-datasets-or-samples)
* It is good practice to use international standard metadata schemas to organise and store your (meta)data in a structured way. A metadata schema describes the relations, such as hierarchy, of the elements that belong to the structure. It is also good practice to use international standard metadata checklists to describe the content your (meta)data. A (meta)data checklist is a fixed set of attributes about the data that needs to be provided. Some attributes are mandatory, some are only recommended or optional. International standard metadata schemas and checklists are developed by and accepted as standards by communities. There are many standard metadata schemas and checklists, some generic, while others discipline-specific. See the paragraph about [how to find standard metadata.](https://rdmkit.elixir-europe.org/metadata_management.html#how-do-you-find-appropriate-standard-metadata-for-datasets-or-samples)

* You can use the attributes of a metadata scheme in a format that is not machine readable (e.g., by copying the metadata fields in a README.txt file or in a Codebook.xls). However, using standard metadata schemes in a machine-readable format will increase the findability of your data.
* You can use the attributes of metadata schemas and checklists in a format that is not machine-readable or -actionable (e.g., by copying the metadata fields in a README.txt file or in a Codebook.xls). However, using standard metadata in a machine-readable or -actionable format will increase the findability of your data.

* Metadata schemes usually rely on ontologies and controlled vocabularies, which make your data more reusable and interoperable. See the paragraph about [how to find ontologies and controlled vocabularies.](https://rdmkit.elixir-europe.org/metadata_management.html#how-do-you-find-appropriate-vocabularies-or-ontologies)
* Metadata schemas and checklists usually rely on ontologies and controlled vocabularies, which make your data more reusable and interoperable. See the paragraph about [how to find ontologies and controlled vocabularies.](https://rdmkit.elixir-europe.org/metadata_management.html#how-do-you-find-appropriate-vocabularies-or-ontologies)

* We recommend familiarizing yourself with the requirements of the repositories that could be appropriate for publishing your data already at the beginning of the project, so that you can start documenting and formatting your data according to their requirements as early as possible.

Expand Down

0 comments on commit 6e94b29

Please sign in to comment.