-
Notifications
You must be signed in to change notification settings - Fork 11
/
metadata.yaml
259 lines (222 loc) · 9.83 KB
/
metadata.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# yaml-language-server: $schema=metadata.json
# single, primary DOI for the dataset
doi: 10.15468/2zjeva
# List of alternative identifiers for the dataset with an ID and an optional type value
# Supported ID types: DOI, GBIF, COL, PLAZI
identifier:
col: 1010
gbif: b96ed603-b710-4b3a-b99b-9bf0de6ef85b
plazi: 3378FFAB6B55FFE0B065C77BFF226429
# Full dataset title
title: ColDP Example. The full dataset title
# Short, hopefully unique name for the dataset
alias: ColDP Example
# Multi parapgraph description / abstract of the dataset
description: |
An abstract about the content of this dataset.
This can be as many paragraphs as you like in literal style YAML.
# Keywords list. Added in v1.1
keyword:
- example
- coldp
- invasives
- legal
- fish
# Official release date of this version in ISO YYYY-MM-DD. Will be part of the default citation!
issued: 2018-06-01
# Version name of this copy
version: v.48 (06/2018)
# ISSN number for a serial publication
issn: 2405-8858
# +++ AGENT +++
#
# Agent entities are used for many fields below and can be either a person, an organisation or a combination of both.
# The minimum requirement is either a persons family name, an organisation name or any of the identifiers for them.
#
# An agent combines the following fields for a person with fields for an organisation:
#
# PERSON fields
# orcid: ORCID person ID, https://orcid.org example: 0000-0001-9745-636X
# family: last name
# given: first name
# ORGANISATION fields
# rorid: ROR organisation ID, https://ror.org example: https://ror.org/05fjyn938
# organisation: name of the organisation / institution
# department: subunit within the organisation, sometimes a project
# city: city
# state: state or province
# country: ISO 2 letter country code
# SHARED fields
# email: email address
# url: webpage
# note: miscellaneous extra information, used for contributor roles
#
# In case no parsed agent can be provided it is permitted to supply a list of simple strings which will then be parsed.
# For the parsing to given and family name to correctly work it is highly recommended to use one of the following formats:
# GivenName FamilyName: Only use this in case the last name is a single token. There can be many first names e.g. John Paul Sartre
# FamilyName, GivenName: Supports any conmplex last name. E.g. Brinch Hansen, Per
# Single point of contact for questions
contact:
given: Rainer
family: Froese
email: [email protected]
# Creators of the dataset. Will be treated as authors in the default citation!
# For available fields see Agent type at the top
# Please provide an ORCID if you can so it can be included in DOI metadata
creator:
- given: Nicolas
family: Bailly
orcid: 0000-0003-4994-0653
- given: Rainer
family: Froese
orcid: 0000-0001-9745-636X
- given: Daniel
family: Pauly
orcid: 0000-0003-3756-4793
# Editors of the dataset. Will be part of the default citation!
editor:
- given: Rainer
family: Froese
email: [email protected]
orcid: 0000-0001-9745-636X
- given: Daniel
family: Pauly
orcid: 0000-0003-3756-4793
# Single publishing organisation. Will be part of the default citation!
publisher:
rorid: 03rmrcq20
organisation: University of British Columbia
department: Global Fisheries Cluster
city: Vancouver
state: B.C.
country: CA
# Agent contributing to the dataset in any other way, but who is not considered an author of the dataset
# Use the optional note field to specify the kind of contribution
contributor:
- given: Atheer
family: Ali
orcid: 0000-0002-2541-968X
email: [email protected]
note: Provided references on fishes of Iraq
- given: Richard Lawrence
family: Pyle
orcid: 0000-0003-0768-1286
organisation: Bernice Pauahi Bishop Museum
department: Natural Sciences
city: Honolulu
state: Hawaii
country: US
note: Review of Pacific species
- given: Markus
family: Döring
orcid: 0000-0001-7757-1889
note: IT support
- organisation: The WorldFish Center
city: Penang
country: MY
- rorid: 02h2x0161
organisation: Helmholtz Centre for Ocean Research Kiel
department: GEOMAR
city: Kiel
country: DE
note: Hosting services
- organisation: Food and Agriculture Organization of the United Nations
rorid: 00pe0tf51
city: Rome
country: IT
- organisation: Muséum National d'Histoire Naturelle
rorid: 03wkt5x30
city: Paris
country: FR
- organisation: Aristotle University of Thessaloniki
rorid: 02j61yw88
city: Thessaloniki
country: GR
# Description of the geographical scope of the dataset
geographicScope: global
# Taxonomic scope of the dataset
taxonomicScope: Cephalaspidomorphi, Sarcopterygii, Elasmobranchii, Holocephali, Actinopterygii, Myxini
# Taxonomic scope of the dataset given as English vernacular name(s)
taxonomicScopeInEnglish: Fishes
# Temporal scope of the dataset
temporalScope: Extant taxa described until 1987
# Integer between 1-5 with 5 expressing highest confidence in quality of the data
confidence: 5
# 0-100 to express the completeness of the dataset in regards to the defined scope
completeness: 95
# Any Open Definition license ID: https://licenses.opendefinition.org/licenses/groups/all.json
# For ChecklistBank please use only CC0-1.0, CC-BY-4.0 or CC-BY-NC-4.0
# Must be CC0-1.0 or CC-BY-4.0 to be used by COL !!!
license: CC0-1.0
# Link to a website for the dataset
url: https://www.fishbase.org
# URL to large logo image
logo: https://www.fishbase.de/images/gifs/fblogo_new.gif
# templates to build links to webpages for individual records of some kind using these variables:
# {ID} individual record identifier
# {TAXONID} individual record identifier for the taxon, i.e accepted name
urlFormatter:
name: https://fishbase.mnhn.fr/summary/{ID}
taxon: https://fishbase.mnhn.fr/summary/{ID}
synonym: https://fishbase.mnhn.fr/Nomenclature/SynonymSummary.php?GSID={TAXONID}&ID={ID}
reference: https://fishbase.mnhn.fr/references/FBRefSummary.php?ID={ID}
author: https://fishbase.mnhn.fr/collaborators/CollaboratorSummary.php?ID={ID}
typeMaterial:
# Documentation of the conversion process from the original source data
# to the ColDP representation in this dataset
conversion:
# human description of what's being done
description: The MySQL database is being exported on a monthly basis to ColDP CSV files with the help of a python script.
# location of the conversion script code or more documentation of the process
url: https://github.com/CatalogueOfLife/coldp-generator
# List of Citations this dataset is derived from.
# We use CSL-JSON fields to represent a structured citation, see below for the main fields used for bibliographies.
#
# NAME fields:
# are lists of people represented either by a simple string or objects with family & given fields.
# In case no parsed name can be provided, simple strings will be parsed.
# For the parsing to given and family name to correctly work it is highly recommended to use one of the following formats:
# 1) GivenName FamilyName: Only use this in case the last name is a single token. There can be many first names e.g. John Paul Sartre
# 2) FamilyName, GivenName: Supports any conmplex last name. E.g. Brinch Hansen, Per
#
# DATE fields:
# are ISO dates that can be truncated to represent a year, year & month or exact date: 1998, 1998-05 or 1998-05-21
#
source:
# example record
- id: ecf
type: book
title: Eschmeyer's Catalog of Fishes
editor:
- Ronald Fricke # simple format: GivenName FamilyName
- Van der Laan, R. # simple format: FamilyName, GivenName
- given: William N. # object format
family: Eschmeyer
issued: 2021-04
version: 13 April 2021
url: https://researcharchive.calacademy.org/research/ichthyology/catalog/fishcatmain.asp
# Full list of supported CSL fields:
- id: # identifier for the source, can be referenced from individual data records via sourceID to indicate the provenance on a record level.
type: # CSL type, e.g. ARTICLE-JOURNAL, BOOK, CHAPTER, DATASET, WEBPAGE. See https://aurimasv.github.io/z2csl/typeMap.xml for a mapping of CSL types to field sets
doi: # a DOI
author: # author list. type=NAME[]
editor: # editor list. type=NAME[]
title: # primary title of the item
containerAuthor: # author(s) of the container holding the item (e.g. the book author for a book chapter). type=NAME[]
containerTitle: # title of the container holding the item (e.g. the book title for a book chapter, the journal title for a journal article)
issued: # date the item was issued/published in possibly truncated ISO format, e.g. 1998, 1998-05 or 1998-05-21. type=DATE
accessed: # date the item has been accessed. type=DATE
collectionTitle: # title of the collection holding the item (e.g. the series title for a book)
collectionEditor: # editor(s) of the collection holding the item (e.g. the series editor for a book). type=NAME[]
volume: # (container) volume holding the item (e.g. “2” when citing a chapter from book volume 2). type=NUMBER
issue: # (container) issue holding the item (e.g. “5” when citing a journal article from journal volume 2, issue 5). type=NUMBER
edition: # (container) edition holding the item (e.g. “3” when citing a chapter in the third edition of a book). type=NUMBER
page: # range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue)
publisher: # publisher
publisherPlace: # geographic location of the publisher
version: # version of the dataset/source
isbn: # International Standard Book Number
issn: # International Standard Serial Number
url: # link to webpage for electronic resources
note: # (short) inline note giving additional item details (e.g. a concise summary or commentary)
notes: Remarks, comments and usage notes about this dataset