-
Notifications
You must be signed in to change notification settings - Fork 26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add metadata and ontologies informations #104
Merged
Merged
Changes from 11 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
f07c087
Update - initial header03-md.md
MartinBoleSlo 64ffc97
remove empty attribute and fix header space
cpauvert d848ea3
Update 03-md.md
magelm 879c2e6
Merge pull request #1 from magelm/main
MartinBoleSlo eb04a60
General metadata description 03-md.md
MartinBoleSlo a320115
draft a section on metadata standards
cpauvert 29792e0
add names to contributor lists
cpauvert 591cbd2
## What is metadata and ## when to collect metadata 03-md.md
MartinBoleSlo 4d6229e
minor correction 03-md.md
MartinBoleSlo 86d51a1
Quickfix syntax hyperlink 03-md.md
MartinBoleSlo f97d550
quickfix V2 03-md.md
MartinBoleSlo c2ec26c
QF v3 Update 03-md.md
MartinBoleSlo c63c70a
precise that we is NFDI4Microbiota and typos
cpauvert 09c1678
Changed flow and purpose 03-md.md
MartinBoleSlo 875315c
Disclaimer on where to do public repo data deposition 03-md.md
MartinBoleSlo d6845ed
reformulate metadata introduction
cpauvert 761484a
fix typos and reformulate metadata section
cpauvert 16c4d97
precise cookbook link, reformulation and slim down links
cpauvert d48b538
Merge branch 'main' into main
RabeaMue File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -4,14 +4,56 @@ category: Research-Data-Management | |||||
layout: default | ||||||
docs_css: markdown | ||||||
redirect_from: /Research-Data-Management | ||||||
empty: true | ||||||
hide: true | ||||||
empty: false | ||||||
hide: false | ||||||
--- | ||||||
|
||||||
# Metadata | ||||||
|
||||||
## What is metadata? | ||||||
## What is metadata? | ||||||
|
||||||
Before we delve into specifications on what Metadata standards for the Microbiology community are or would be, let us explain what metadata is and how you have probably already used it at least once. | ||||||
|
||||||
In the simplest terms, metadata is **data** about data. So, in general, metadata provides us with information about other data but does not tell us anything about the content of the data itself. | ||||||
|
||||||
For example, when you use your smartphone camera to take photos of your loved one, your device automatically creates the corresponding metadata regarding that photograph. The metadata, in this case, should at least contain the following (depending on your device settings): | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
1. Name of file (e.g., *20221110_141434.jpg)*) | ||||||
2. Type of file (e.g. *JPEG image (image/jpeg)*) | ||||||
3. Size of file (e.g. *1,2 MB (1.213.634 bytes)*) | ||||||
4. Camera information: Lens, focal length, aperture, exposure, ISO speed, flash, shutter count | ||||||
6. Creation date of file (e.g., *2024-02-14 09:53:47*) | ||||||
7. Width of photograph (e.g. 2435 pixels) | ||||||
8. Height of photograph (e.g., 2435 pixels) | ||||||
9. Location stamp (if enabled in the device) (e.g., 51.312568, 12.412855) | ||||||
10. Several permissions and locations of the file (owner, access, etc.) | ||||||
|
||||||
Several years later, you find the photo on your **new mobile device**, and you start to wonder **where** and **when** you took the picture. You open up the photograph file description, and there it is. Even on your new device, you can still access the metadata of the photograph you took several years before. So you can correctly recall when the photo was taken and where it was created. If the environmental conditions match, you can replicate the photograph using the Camera information. | ||||||
cpauvert marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
It is worth noting here that in this particular case, your metadata was interoperable (you could access it even on your new mobile device - by you and your device), and it was reusable (in theory, you could use the metadata of the original photo to replicate it, even several years later). Still, it was not findable or accessible for anyone else. If you do not know to what we are hinting here, we advise you to read the [**FAIR Data Principles**](./04-fair.md) section of this repository. | ||||||
|
||||||
In this particular case, we could consider ourselves lucky as the metadata for our photograph was created automatically. That might not always be the case when dealing with (meta)data generated in our research. | ||||||
|
||||||
## When to collect your metadata? | ||||||
|
||||||
As is usually the case in sciences, your research (and the wider microbiological community) can benefit highly from the rigorous and timely planning of your experiments, including metadata collection. In this case, we refer you to other subsections of this KnowledgeBase <insert_appropriate_links_inside_repo> that should be considered when planning your experiments. | ||||||
|
||||||
Metadata collection should be planned, but at the same time, it can be overwhelming. What is enough to describe it? Was it crucial to note down the pipette I was using? Will one year older me understand what I wrote down in my notebook/ELN? Will other researchers make sense of the (meta)data I collected? Will other researchers be able to replicate my research if I did not note down my in-house DNA extraction protocol? These and other considerations not noted here should be thoroughly thought out before the start of experimental procedures. Some of the metadata can even be collected and documented before the start of experiments if you already know how to collect your samples, sequence them (if sequencing is a part of the analysis), and analyze them. | ||||||
|
||||||
|
||||||
|
||||||
# Metadata standards | ||||||
|
||||||
Once a community agrees to a set of relevant metadata for their field, they can devise metadata standards. | ||||||
A metadata standard is usually defined for a given type of data and by different stakeholders (e.g., users community, data repositories). | ||||||
For every metadata fields part of a metadata standard, one could expect a human-readable description of the metadata field paired with a machine-readable persistent identifier of the field, then an indication of the level of requirements of this field in the standard and how many values of this field are expected (that is the cardinality). | ||||||
|
||||||
|
||||||
[More than a thousand standards are listed by the organisation `FAIRsharing.org`](https://fairsharing.org/search?fairsharingRegistry=Standard) which can be overwhelming. | ||||||
We compiled a [list of widely used metadata standards in the fied of microbiome research](https://github.com/NFDI4Microbiota/MetadataStandards) | ||||||
|
||||||
|
||||||
# Metadata management | ||||||
|
||||||
# Metadata quality control | ||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.