Skip to content

Commit 4aad2e5

Browse files
embrunaembruna
committed
formatting
1 parent 5ea4b46 commit 4aad2e5

2 files changed

Lines changed: 58 additions & 63 deletions

File tree

‎class_materials/class_sessions/08_metadata/metadata.qmd‎

Lines changed: 50 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -6,113 +6,108 @@
66
# - name: University of Florida
77
title-block-style: default
88
date-modified: last-modified
9-
109
---
11-
# Metadata {#sec-metadata}
1210

13-
Data repositories such as [Dryad](https://datadryad.org) and [ICPSR](https://www.icpsr.umich.edu/web/pages/) are designed to permanently store the data that are used in research so it is available to future scholars. To use the data, it is important to have good _metadata_: metadata describe the data themselves, rather than why the study was conducted, hypotheses, results, or conclusions. Metadata include thorough description of the data file, the context in which the data were collected, the measurements that were made, the tools used to gather the data, and the quality of the data themselves.
11+
# Metadata {#sec-metadata}
12+
13+
Data repositories such as [Dryad](https://datadryad.org) and [ICPSR](https://www.icpsr.umich.edu/web/pages/) are designed to permanently store the data that are used in research so it is available to future scholars. To use the data, it is important to have good *metadata*: metadata describe the data themselves, rather than why the study was conducted, hypotheses, results, or conclusions. Metadata include thorough description of the data file, the context in which the data were collected, the measurements that were made, the tools used to gather the data, and the quality of the data themselves.
1414

1515
We want data and metadata to adhere to the FAIR Principles for [Scientific Data Management and Stewardship](https://www.nature.com/articles/sdata201618), meaning they should be:
16-
17-
* Findable: persistent identifiers & basic machine-actionable metadata
18-
* Accessible: can be read by machines & humans
19-
* Interoperable: use shared vocabularies / ontologies, machine-accessible (meta)data
20-
* Re-Usable: descriptions allow others to reuse and link with other data sources
2116

22-
The metadata for the types of data used in our work should also (typically) include the 5 Classes of metadata descriptors from [Michener _et al._ 1997](https://esajournals.onlinelibrary.wiley.com/doi/10.1890/1051-0761%281997%29007%5B0330%3ANMFTES%5D2.0.CO%3B2)
17+
- Findable: persistent identifiers & basic machine-actionable metadata
18+
- Accessible: can be read by machines & humans
19+
- Interoperable: use shared vocabularies / ontologies, machine-accessible (meta)data
20+
- Re-Usable: descriptions allow others to reuse and link with other data sources
21+
22+
The metadata for the types of data used in our work should also (typically) include the 5 Classes of metadata descriptors from [Michener *et al.* 1997](https://esajournals.onlinelibrary.wiley.com/doi/10.1890/1051-0761%281997%29007%5B0330%3ANMFTES%5D2.0.CO%3B2)
2323

24-
* Class I: alert potential secondary users to the existence of data sets that fall within specific temporal, spatial, and thematic domains.
25-
* Class II: describe the research resulting in a data set.
26-
* Class III: status of the data set and information on its accessibility.
27-
* Class IV: all the attributes related to the structure of the data file.
28-
* Class V: all other related information that might be necessary for secondary usage, publishing the data set, or auditing the data set.
24+
- Class I: alert potential secondary users to the existence of data sets that fall within specific temporal, spatial, and thematic domains.
25+
- Class II: describe the research resulting in a data set.
26+
- Class III: status of the data set and information on its accessibility.
27+
- Class IV: all the attributes related to the structure of the data file.
28+
- Class V: all other related information that might be necessary for secondary usage, publishing the data set, or auditing the data set.
2929

3030
## What are Metdatadata?
3131

32-
1. E. Bruna Video for LAS6292: [Why Metadata?](https://youtu.be/wrt-3l71DJ4)
32+
1. E. Bruna Video for LAS6292: [Why Metadata?](https://youtu.be/wrt-3l71DJ4)
3333

34-
1. ICPSR: [What is a Codebook?](https://www.icpsr.umich.edu/web/HMCA/cms/1983)
34+
2. ICPSR: [What is a Codebook?](https://www.icpsr.umich.edu/web/HMCA/cms/1983)
3535

3636
## Best practices for preparing metadata
3737

38-
1. ["Best Practices in Creating Social Science Metadata."](https://www.icpsr.umich.edu/files/deposit/dataprep.pdf) p.32 in the ICPSR *Guide to Social Science Data Preparation and Archiving: Best Practice Throughout the Data Life Cycle (6th Edition)*.
38+
1. ["Best Practices in Creating Social Science Metadata."](https://www.icpsr.umich.edu/files/deposit/dataprep.pdf) p.32 in the ICPSR *Guide to Social Science Data Preparation and Archiving: Best Practice Throughout the Data Life Cycle (6th Edition)*.
3939

40-
1. Michener, W.K., et al . 1997. Non-geospatial metadata for the ecological sciences. Ecological Applications 7: 330–342.
41-
[[read online]](https://esajournals.onlinelibrary.wiley.com/doi/abs/10.1890/1051-0761%281997%29007%5B0330%3ANMFTES%5D2.0.CO%3B2)
40+
2. Michener, W.K., et al . 1997. Non-geospatial metadata for the ecological sciences. Ecological Applications 7: 330–342.\
41+
[\[read online\]](https://esajournals.onlinelibrary.wiley.com/doi/abs/10.1890/1051-0761%281997%29007%5B0330%3ANMFTES%5D2.0.CO%3B2)
4242

43-
1. Pp 446-450 in Bernard, H.R. and Bernard, H.R., 2013. Social research methods: Qualitative and quantitative approaches. Sage.
43+
3. Pp 446-450 in Bernard, H.R. and Bernard, H.R., 2013. Social research methods: Qualitative and quantitative approaches. Sage.
4444

45-
1. ICPSR [*Guide to Social Science Data Preparation and Archiving:
46-
Best Practice Throughout the Data Life Cycle (6th Edition)*](https://www.icpsr.umich.edu/web/pages/deposit/guide/)
45+
4. ICPSR [*Guide to Social Science Data Preparation and Archiving: Best Practice Throughout the Data Life Cycle (6th Edition)*](https://www.icpsr.umich.edu/web/pages/deposit/guide/)
4746

48-
2. DataONE Community Engagement & Outreach Working Group (2017) ["Metadata Management"](https://dataoneorg.github.io/Education/lessons/07_metadata/index). Accessed through the Data Management Skillbuilding Hub on Aug 31, 2020
47+
5. DataONE Community Engagement & Outreach Working Group (2017) ["Metadata Management"](https://dataoneorg.github.io/Education/lessons/07_metadata/index). Accessed through the Data Management Skillbuilding Hub on Aug 31, 2020
4948

5049
## Discipline-specific metadata standards
5150

52-
It is worth looking in these catalogs to see if you can find metadata standards for your discipline. They will provide suggestions on not only what to include, but the standard vocabulary for your discipline.
51+
It is worth looking in these catalogs to see if you can find metadata standards for your discipline. They will provide suggestions on not only what to include, but the standard vocabulary for your discipline.
5352

54-
1. RDA [Catalog of metadata standards for different disciplines](https://rd-alliance.github.io/metadata-directory/subjects/)
53+
1. RDA [Catalog of metadata standards for different disciplines](https://rd-alliance.github.io/metadata-directory/subjects/)
5554

56-
1. UK Digital Curation Center [Directory of metadata standards for different disciplines](https://www.dcc.ac.uk/guidance/standards/metadata)
55+
2. UK Digital Curation Center [Directory of metadata standards for different disciplines](https://www.dcc.ac.uk/guidance/standards/metadata)
5756

58-
2. Ecological data: [Ecological Metadata Language](http://knb.ecoinformatics.org/eml_metadata_guide.html)
57+
3. Ecological data: [Ecological Metadata Language](http://knb.ecoinformatics.org/eml_metadata_guide.html)
5958

60-
3. Museum Specimens: [Darwin Core](http://rs.tdwg.org/dwc/index.htm)
59+
4. Museum Specimens: [Darwin Core](http://rs.tdwg.org/dwc/index.htm)
6160

62-
4. Geography Markup Language ([GML](http://www.opengeospatial.org/standards/gml)): Emphasis on geographic features (roads, highways, bridges)
63-
64-
5. Humanities: UF Digital Collections (UFDC) [key metadata fields](https://guides.uflib.ufl.edu/ufdcmetadata) used for non-published items such as posters, archival materials, artists' files, field notebooks, etc. Includes a link to a template you can download. See also the different [Metadata Preparation Guides](https://guides.uflib.ufl.edu/describeitems/examples) provided by the University of Florida Digital Collections (UFDC), the [UF Humanities Archives Metadata Template](https://docs.google.com/spreadsheets/d/1K9RRNWrWbK0ikQai4_baBmxobqsX6jwEsiAHVjEJRDE/edit#gid=1745662283), and the [metadata required by the Qualitative Data Repository](https://qdr.syr.edu/content/qdr-metadata-application-profile).
61+
5. Geography Markup Language ([GML](http://www.opengeospatial.org/standards/gml)): Emphasis on geographic features (roads, highways, bridges)
6562

63+
6. Humanities: UF Digital Collections (UFDC) [key metadata fields](https://guides.uflib.ufl.edu/ufdcmetadata) used for non-published items such as posters, archival materials, artists' files, field notebooks, etc. Includes a link to a template you can download. See also the different [Metadata Preparation Guides](https://guides.uflib.ufl.edu/describeitems/examples) provided by the University of Florida Digital Collections (UFDC), the [UF Humanities Archives Metadata Template](https://docs.google.com/spreadsheets/d/1K9RRNWrWbK0ikQai4_baBmxobqsX6jwEsiAHVjEJRDE/edit#gid=1745662283), and the [metadata required by the Qualitative Data Repository](https://qdr.syr.edu/content/qdr-metadata-application-profile).
6664

6765
## Metadata templates
6866

69-
I have created metadata templates based on information from ICSPR (for social sciences) and Michener _et al._ 1997 (for biophysical sciences) that can be downloaded and edited; you can add more fields or delete any that are not relevant. Note that Table 1 in Michener _et al._ is much more comprehensive and provides additional guidance on how to make sure the metadata are useful. The templates are available in `.txt`, `.Rmd`, and `.qmd` format).
70-
67+
I have created metadata templates based on information from ICSPR (for social sciences) and Michener *et al.* 1997 (for biophysical sciences) that can be downloaded and edited; you can add more fields or delete any that are not relevant. Note that Table 1 in Michener *et al.* is much more comprehensive and provides additional guidance on how to make sure the metadata are useful. The templates are available in `.txt`, `.Rmd`, and `.qmd` format).
7168

72-
1. **Metadata Template for Social Sciences ** based on ICSPR standards: [.txt format](https://github.com/BrunaLab/LAS6292_DataManagement/blob/955ff1d91ee9e1655019b5ced69c3676a80cdf58/instructor-materials/class-sessions/08-metadata/ICPSR_Metadata.txt) or [.Rmd format](https://github.com/BrunaLab/LAS6292_DataManagement/blob/955ff1d91ee9e1655019b5ced69c3676a80cdf58/instructor-materials/class-sessions/08-metadata/ICPSR_Metadata.Rmd).
69+
1. **Metadata Template for Social Sciences** based on ICSPR standards: [.txt format](https://github.com/BrunaLab/LAS6292_DataManagement/blob/955ff1d91ee9e1655019b5ced69c3676a80cdf58/instructor-materials/class-sessions/08-metadata/ICPSR_Metadata.txt) or [.Rmd format](https://github.com/BrunaLab/LAS6292_DataManagement/blob/955ff1d91ee9e1655019b5ced69c3676a80cdf58/instructor-materials/class-sessions/08-metadata/ICPSR_Metadata.Rmd).
7370

74-
1. **Metadata template for Biophysical Sciences** based on Table 1 from Michener _et al._ 1997: [.txt format](https://github.com/BrunaLab/LAS6292_DataManagement/blob/955ff1d91ee9e1655019b5ced69c3676a80cdf58/instructor-materials/class-sessions/08-metadata/Michener_etal_1997_Table1.txt) or [.Rmd format](https://github.com/BrunaLab/LAS6292_DataManagement/blob/955ff1d91ee9e1655019b5ced69c3676a80cdf58/instructor-materials/class-sessions/08-metadata/Michener_etal_1997_Table1.Rmd)
71+
2. **Metadata template for Biophysical Sciences** based on Table 1 from Michener *et al.* 1997: [.txt format](https://github.com/BrunaLab/LAS6292_DataManagement/blob/955ff1d91ee9e1655019b5ced69c3676a80cdf58/instructor-materials/class-sessions/08-metadata/Michener_etal_1997_Table1.txt) or [.Rmd format](https://github.com/BrunaLab/LAS6292_DataManagement/blob/955ff1d91ee9e1655019b5ced69c3676a80cdf58/instructor-materials/class-sessions/08-metadata/Michener_etal_1997_Table1.Rmd)
7572

76-
1. **Metadata for the Humanities or those working primarily with Qualitative Data:** The metadata required often depend on the type of material with which you work (e.g., oral history, photos, digital, printed). If your data is in this domain, you can use this general template from the UF Humanities Archives: [Template #2](https://docs.google.com/spreadsheets/d/1K9RRNWrWbK0ikQai4_baBmxobqsX6jwEsiAHVjEJRDE/edit#gid=1745662283). You can also review the [metadata required by the Qualitative Data Repository](https://qdr.syr.edu/content/qdr-metadata-application-profile).
73+
3. **Metadata for the Humanities or those working primarily with Qualitative Data:** The metadata required often depend on the type of material with which you work (e.g., oral history, photos, digital, printed). If your data is in this domain, you can use this general template from the UF Humanities Archives: [Template #2](https://docs.google.com/spreadsheets/d/1K9RRNWrWbK0ikQai4_baBmxobqsX6jwEsiAHVjEJRDE/edit#gid=1745662283). You can also review the [metadata required by the Qualitative Data Repository](https://qdr.syr.edu/content/qdr-metadata-application-profile).
7774

7875
<!-- TODO: UPDATE WITH these for oral-history, and the -->
76+
7977
<!-- https://digitalomnium.com/oral-history-digital-toolbox-my-favorites/ -->
78+
8079
<!-- [Template No.1](https://docs.google.com/spreadsheets/d/1x98TWee85Gq9oas90JJYtB5DyPBkMSNEs29Mb1qyAeQ/edit#gid=0) from UF's Samuel Proctor Oral History Project, -->
8180

82-
## Tools for creating machine-readable metadata
81+
## Tools for creating machine-readable metadata
8382

84-
I include these here in case you want to try using them. It's not required, but it could definitely make your life easier if there is a standard tool for your discipline (e.g., MORPHO if you are working with ecological data).
83+
I include these here in case you want to try using them. It's not required, but it could definitely make your life easier if there is a standard tool for your discipline (e.g., MORPHO if you are working with ecological data).
8584

8685
<!-- 1. [Morpho](https://github.com/NCEAS/morpho): desktop application that allows researchers to create metadata and then (if they wish) upload to KNB. No longer maintained but open source and can be very useful. -->
8786

88-
1. [giant list from the RDA](https://rd-alliance.github.io/metadata-directory/tools/) of tools for creating standardized metadata for different disciplines
87+
1. [giant list from the RDA](https://rd-alliance.github.io/metadata-directory/tools/) of tools for creating standardized metadata for different disciplines
8988

90-
2. [USGS Metadata Wizard](https://www.sciencebase.gov/catalog/item/50ed7aa4e4b0438b00db080a)
89+
2. [USGS Metadata Wizard](https://www.sciencebase.gov/catalog/item/50ed7aa4e4b0438b00db080a)
9190

92-
3. [TKME](https://geology.usgs.gov/tools/metadata/tools/doc/tkme.html)
91+
3. [TKME](https://geology.usgs.gov/tools/metadata/tools/doc/tkme.html)
9392

94-
4. [CatMDEdit](http://catmdedit.sourceforge.net/)
93+
4. [CatMDEdit](http://catmdedit.sourceforge.net/)
9594

96-
5. [Coastal and Marine Science Data Repository - GRIIDC](https://www.griidc.org/): Select the [Dataset Information Form Guidance](https://www.griidc.org/media/dataset_information_form_guidance.pdf) from the [Training and User Guides page](https://www.griidc.org/training-user-guides).
95+
5. [Coastal and Marine Science Data Repository - GRIIDC](https://www.griidc.org/): Select the [Dataset Information Form Guidance](https://www.griidc.org/media/dataset_information_form_guidance.pdf) from the [Training and User Guides page](https://www.griidc.org/training-user-guides).
9796

9897
## Metadata Dictionaries
9998

100-
1. [USGS](https://apps.usgs.gov/thesaurus/)
101-
102-
2. [Global Change Master Dictionary](https://catalog.data.gov/dataset/global-change-master-directory-gcmd) **[Note: deprecated June 2020]**
103-
104-
3. [USGS Geographic Names](https://www.usgs.gov/core-science-systems/ngp/board-on-geographic-names)
105-
106-
4. [Getty Thesaurus of Geographic Names](http://www.getty.edu/research/tools/vocabularies/tgn/)
107-
99+
1. [USGS](https://apps.usgs.gov/thesaurus/)
108100

109-
## Organizations developing metadata standards and schema
101+
2. [Global Change Master Dictionary](https://catalog.data.gov/dataset/global-change-master-directory-gcmd) **\[Note: deprecated June 2020\]**
110102

111-
1. [The Research Data Alliance (RDA) ](https://www.rd-alliance.org/)"has the goal goal of building the social and technical infrastructure to enable open sharing and re-use of data."
103+
3. [USGS Geographic Names](https://www.usgs.gov/core-science-systems/ngp/board-on-geographic-names)
112104

113-
2. [DDI Alliance](https://ddialliance.org/): "Established in 2003, the Data Documentation Initiative Alliance (DDI Alliance) is an international collaboration dedicated to establishing metadata standards and semantic products for describing social science data, data covering human activity, and other data based on observational methods."
105+
4. [Getty Thesaurus of Geographic Names](http://www.getty.edu/research/tools/vocabularies/tgn/)
114106

115-
3. [The Dublin Core Metadata Initiative](https://www.dublincore.org/) is "an organization supporting innovation in metadata design and best practices across the metadata ecology".
107+
## Organizations developing metadata standards and schema
116108

109+
1. [The Research Data Alliance (RDA)](https://www.rd-alliance.org/)"has the goal goal of building the social and technical infrastructure to enable open sharing and re-use of data."
117110

111+
2. [DDI Alliance](https://ddialliance.org/): "Established in 2003, the Data Documentation Initiative Alliance (DDI Alliance) is an international collaboration dedicated to establishing metadata standards and semantic products for describing social science data, data covering human activity, and other data based on observational methods."
118112

113+
3. [The Dublin Core Metadata Initiative](https://www.dublincore.org/) is "an organization supporting innovation in metadata design and best practices across the metadata ecology".

‎class_materials/class_sessions/08_metadata/metadata_class.qmd‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,17 +56,17 @@ Follow the links to the page below, where you will find the data and metadata fr
5656

5757
2. Do the data and metadata appear to adhere to the FAIR Principles?
5858

59-
- Findable: persistent identifiers & basic machine-actionable metadata
60-
- Accessible: can be read by machines & humans
61-
- Interoperable: use shared vocabularies / ontologies, machine-accessible (meta)data
62-
- Re-Usable: descriptions allow others to reuse and link with other data sources
59+
- Findable: persistent identifiers & basic machine-actionable metadata
60+
- Accessible: can be read by machines & humans
61+
- Interoperable: use shared vocabularies / ontologies, machine-accessible (meta)data
62+
- Re-Usable: descriptions allow others to reuse and link with other data sources
6363

6464
2. Did they include the 5 metadata descriptors?
6565

66-
- Class I: alert potential secondary users to the existence of data sets that fall within specific temporal, spatial, and thematic domains.
67-
- Class II: describe the research resulting in a data set.
68-
- Class III: status of the data set and information on its accessibility.
69-
- Class IV: all the attributes related to the structure of the data file.
66+
- Class I: alert potential secondary users to the existence of data sets that fall within specific temporal, spatial, and thematic domains.
67+
- Class II: describe the research resulting in a data set.
68+
- Class III: status of the data set and information on its accessibility.
69+
- Class IV: all the attributes related to the structure of the data file.
7070
- Class V: all other related information that might be necessary for secondary usage, publishing the data set, or auditing the data set.
7171

7272
3. Does anything else stand out about the data metadata files? For example...

0 commit comments

Comments
 (0)