Journal:Persistent identification of instruments - Revision history

Shawndouglas: Finished adding rest of content.

2020-09-16T21:57:37Z

Finished adding rest of content.

← Older revision		Revision as of 21:57, 16 September 2020
Line 19:		Line 19:
	\|download = [https://datascience.codata.org/articles/10.5334/dsj-2020-018/galley/962/download/ https://datascience.codata.org/articles/10.5334/dsj-2020-018/galley/962/download/] (PDF)		\|download = [https://datascience.codata.org/articles/10.5334/dsj-2020-018/galley/962/download/ https://datascience.codata.org/articles/10.5334/dsj-2020-018/galley/962/download/] (PDF)
	}}		}}
	~~{{ombox~~
	~~\| type = notice~~
	~~\| image = [[Image:Emblem-important-yellow.svg\|40px]]~~
	~~\| style = width: 500px;~~
	~~\| text = This article should be considered a work in progress and incomplete. Consider this article incomplete until this notice is removed.~~
	}}
	==Abstract==		==Abstract==
	Instruments play an essential role in creating research data. Given the importance of instruments and associated [[metadata]] to the assessment of [[data quality]] and data reuse, globally unique, persistent, and resolvable identification of instruments is crucial. The Research Data Alliance Working Group Persistent Identification of Instruments (PIDINST) developed a community-driven solution for persistent identification of instruments, which we present and discuss in this paper. Based on an analysis of 10 use cases, PIDINST developed a metadata schema and prototyped schema implementation with [[wikipedia:DataCite\|DataCite]] and ePIC as representative [[wikipedia:Persistent identifier\|persistent identifier]] infrastructures, and with HZB (Helmholtz-Zentrum Berlin für Materialien und Energie) and the BODC (British Oceanographic Data Centre) as representative institutional instrument providers. These implementations demonstrate the viability of the proposed solution in practice. Moving forward, PIDINST will further catalyze adoption and consolidate the schema by addressing new stakeholder requirements.		Instruments play an essential role in creating research data. Given the importance of instruments and associated [[metadata]] to the assessment of [[data quality]] and data reuse, globally unique, persistent, and resolvable identification of instruments is crucial. The Research Data Alliance Working Group Persistent Identification of Instruments (PIDINST) developed a community-driven solution for persistent identification of instruments, which we present and discuss in this paper. Based on an analysis of 10 use cases, PIDINST developed a metadata schema and prototyped schema implementation with [[wikipedia:DataCite\|DataCite]] and ePIC as representative [[wikipedia:Persistent identifier\|persistent identifier]] infrastructures, and with HZB (Helmholtz-Zentrum Berlin für Materialien und Energie) and the BODC (British Oceanographic Data Centre) as representative institutional instrument providers. These implementations demonstrate the viability of the proposed solution in practice. Moving forward, PIDINST will further catalyze adoption and consolidate the schema by addressing new stakeholder requirements.
Line 626:		Line 621:

	Together, instrument papers and landing pages provide important documentation that helps scientists and users more generally understand the instruments and how they have been used in scientific experiments. This documentation is designed to be read by humans. Structured metadata linked using persistent identifiers, on the other hand, enable machine readability and processing of information about instruments. These representations of information, for humans and for machines, are complementary.		Together, instrument papers and landing pages provide important documentation that helps scientists and users more generally understand the instruments and how they have been used in scientific experiments. This documentation is designed to be read by humans. Structured metadata linked using persistent identifiers, on the other hand, enable machine readability and processing of information about instruments. These representations of information, for humans and for machines, are complementary.

			As we presented here, PIDINST prototyped the schema implementation with both DataCite and ePIC. These implementations have pros and cons, which we briefly discuss. Worldwide, DOIs arguably have better recognition. Furthermore, the infrastructure for minting DataCite DOIs is easier for many institutions and comes with substantial tooling. On the other hand, DataCite DOIs may incur considerable costs if DOIs are minted for a large number of instruments. Furthermore, ePIC handles are more flexible when it comes to supporting custom metadata standards. Indeed, as our results clearly demonstrate, we could implement the PIDINST schema as proposed only with ePIC.

			While the PIDINST schema has already been shown to be viable in practice, it is not yet finalized in all details. One of the remaining open issues is that the group did not achieve a consensus on the best representation of an instrument’s serial number. We do have the <tt>AlternateIdentifier</tt> property, so in principle, adding an <tt>AlternateIdentifier</tt> with <tt>alternateIdentifierType</tt> value "SerialNumber" would be the obvious way to include the serial number in the metadata. Consequently, adding a dedicated <tt>SerialNumber</tt> property to the schema has been rejected as redundant with <tt>AlternateIdentifier</tt>. The only drawback is that <tt>alternateIdentifierType</tt> is defined as free text and not a controlled vocabulary. As a result, there is no guarantee that everyone who registers instrument metadata spells this type alike, which may be a problem when searching for instrument metadata by serial number. Changing the definition of <tt>alternateIdentifierType</tt> to a controlled vocabulary is problematic, too, as there may be new use cases for <tt>AlternateIdentifier</tt> that would not be readily supported. Finally, the definition for some schema properties (e.g., <tt>InstrumentType</tt> and <tt>MeasuredVariable</tt>) is rather vague and the value is defined as free text. This is mainly due to the lack of suitable vocabularies. Other open issues with the schema, such as the final definitions of the terms in some controlled vocabularies, are relatively minor.

			A further limitation of the presented work is the relatively small set of use cases and their bias for the earth sciences (60%), and therefore limited coverage of the disciplines. In current and future work, PIDINST will continue maintaining its deliverables, including advancing and supporting further adoptions in disciplines other than the earth sciences. As such, PIDINST will test the viability of the proposed metadata schema and its implementation with PID infrastructures more widely. As part of metadata schema maintenance, PIDINST will consider, discuss, and implement the concerns various communities may have.

			The use of persistent identifiers for instruments is currently an emerging solution that is gaining momentum operationally, as evidenced in our adoption cases (see next section). Increasing its uptake in the future may also involve engagement with instrument manufacturers. They could provide machine-readable instrument specifications, support the inclusion of the persistent identifier into instrument output, or even register instruments “at birth.”

			We have recently seen the development of dedicated community-level sensor registries aimed at harmonizing and standardizing sensor metadata across instrument networks, as exemplified by the [https://www.esonetyellowpages.com/ European Esonet Yellow Pages] for deep sea observatories or the NSF/EarthCube X-Domes<ref name="FredericksPromo18">{{cite journal \|title=Promoting the capture of sensor data provenance: a role-based approach to enable data quality assessment, sensor management and interoperability \|journal=Open Geospatial Data, Software and Standards \|author=Fredericks, J.; Botts, M. \|volume=3 \|at=3 \|year=2018 \|doi=10.1186/s40965-018-0048-5}}</ref> for cross-domain environmental sensors. The use of persistent identifiers in such registries would not only boost uptake, but also these facilities may become direct members of PID providers, minting identifiers for institutions or individuals who do not have dedicated PID services. Uptake may also be accelerated through adoption by other PID providers (e.g., [https://ezid.cdlib.org/ EZID]). To support adoption in communities, PIDINST has published the schema as a “living document” on GitHub, where users may request updates to the schema, helping it to evolve with new and specialized stakeholders.

			==Adoption==
			In addition to HZB and BODC, who have already demonstrated the practical viability of the proposed solution, we briefly present in this section how other research infrastructures and institutional instrument providers motivate and plan the implementation of the proposed solution.

			The Integrated Carbon Observation System (ICOS) is a pan-european research infrastructure for quantifying and understanding the greenhouse gas balance of the European continent. It conducts many continuous ''in-situ'' measurements like gas concentrations, wind speed and direction, humidity, temperature, etc. To deliver high-quality measurement data, ICOS considers the adoption of a persistent identifier for instruments a must for documenting data provenance and tracking calibration history.

			[https://pangaea.de/ PANGAEA] is a data infrastructure for archiving and publishing earth and environmental science datasets. It is jointly managed by the Alfred Wegener Institute, Helmholtz Center for Polar and Marine Research (AWI), and the Center for Marine Environmental Sciences (MARUM) of University of Bremen. The infrastructure holds more than 380,000 persistently identified (DOI) datasets from individual researchers, projects, data centers, and research infrastructures. The metadata of a dataset includes relations between the dataset and related persistently identified entities such as specimens, authors, and articles. Metadata can be further enriched with instrument information. Using the [https://sensor.awi.de/ AWI Sensor Information System], a subset of the published datasets has already been linked to their instruments. Since source information of a dataset (e.g., instrument and method) is essential to interpreting the quality of the dataset and to facilitating its reusability, further work should be done to link the remaining and new data submissions with their instrument PIDs, where applicable. As a data provider, PANGAEA only curates limited information of a device, such as device name, identifier, and type.<ref name="StockerPANGEA19">{{cite web \|url=https://github.com/rdawg-pidinst/use-cases/blob/master/12-PANGAEA.md \|title=PANGAEA Data Publisher User Case \|author=Stocker, M. \|work=GitHub - rdawg-pidinst / use-cases \|date=10 December2019}}</ref> For both the persistent identification as well as for the description of instruments, PANGAEA thus relies on institutional instrument providers.

			[https://eiscat.se/eiscat3d-information/ EISCAT3D] will be an international research infrastructure, using radar observations and the incoherent scatter technique for studies of the atmosphere and the near-Earth space environment above the Fenno-Scandinavian Arctic, as well as for the support of the solar system and radio astronomy sciences. EISCAT3D will implement persistent identification for instruments following the recommendations by PIDINST. The radar is complex, more digital than previous radars, and is roughly divided into a number of separate units. While software is a substantial constituent of these units, they can be largely be regarded as hardware units, each persistently identified. Updates to the units will be primarily to software and result in new unit versions with own PIDs. The radar itself can also be persistently identified, and the relation type "HasComponent" can be used to relate to the persistently identified units.

			==Conclusion==
			The Research Data Alliance Working Group Persistent Identification of Instruments (RDA WG PIDINST) was created with the aim to develop a community-driven solution for persistent identification of instruments. Based on use cases, the WG published a metadata schema and prototyped schema implementation with DataCite and ePIC, as well as with two institutional instrument providers. The WG has thus demonstrated the practical viability of the proposed solution for persistent and consistent identification of instruments for citation, cross-linking, and retrieval purposes across local and global instrument facilities, networks, and data systems. We argue that one of the key advantages of the proposed solution is that it builds on existing PID infrastructure. PIDINST encourages communities to explore both the DataCite and ePIC implementation in order to gain a better understanding for which use cases they serve best. In addition to maintaining the schema and addressing new stakeholder requirements, PIDINST will continue to actively engage with stakeholders to promote further adoption of the schema.

			==Acknowledgements==
			We would like to thank all use case authors for their invaluable contribution to this work as well as the participants of online and offline meetings for their contributions. We also thank DataCite and ePIC for helpful cooperation. Finally, we thank the Research Data Alliance for endorsing and supporting the PIDINST WG. This work was supported by the FREYA project, which has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement Nr. 777523.

			===Funding===
			This paper was supported by the RDA Europe 4.0 project that has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 777388.

			===Competing interests===
			Ulrich Schwardmann is a member of the management board of the ePIC Persistent Identifier Consortium for eResearch, which is on a voluntary basis. All other authors declare that they have no competing interests.

	==References==		==References==
Line 640:		Line 666:
	[[Category:LIMSwiki journal articles on informatics]]		[[Category:LIMSwiki journal articles on informatics]]
	[[Category:LIMSwiki journal articles on standards]]		[[Category:LIMSwiki journal articles on standards]]
			[[Category:LIMSwiki journal articles on sensors and sensor networks]]

Shawndouglas: Saving and adding more.

2020-09-16T18:50:31Z

Saving and adding more.

← Older revision		Revision as of 18:50, 16 September 2020
Line 486:		Line 486:
	Both the DataCite mapping and the ePIC implementation of the PIDINST schema have been prototypically tested with institutional instrument providers. As a first test case for the DataCite mapping, HZB minted four DOIs with DataCite for HZB instruments: two beamlines at the Berlin Research Reactor BER-II<ref name="HZBE2Flat">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1698&typoid=37694 \|title=E2 Flat-Cone Diffractometer \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000001}}</ref><ref name="HZBE9Fine">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1702 \|title=E9 Fine Resolution Powder Diffractometer (FIREPOD) \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000002}}</ref>, one beamline at the synchrotron radiation source BESSY II<ref name="HZB_UE52">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1927 \|title=UE52_PGM Nano cluster trap \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000003}}</ref>, and one experimental station at BESSY II.<ref name="HZBNano">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1848 \|title=NanoclusterTrap \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000004}}</ref> The DOIs resolve to the respective instrument pages from the HZB instrument database, which already existed beforehand and were thus not created for this purpose. One particularity with these instruments is that they are custom-built by HZB. Thus, in the metadata "HZB" appears as Creator as well as Contributor, with property <tt>contributorType</tt> value "HostingInstitution." It is noteworthy that one of the DOIs uses the additional property <tt>fundingReference</tt> from the DataCite schema to acknowledge external funding that HZB received for upgrading the instrument. This property was not considered in the PIDINST schema, or in the DataCite mapping. HZB plans to continue the adoption and to mint DOIs for all its beamlines and experimental stations that are in user operation in the near future.		Both the DataCite mapping and the ePIC implementation of the PIDINST schema have been prototypically tested with institutional instrument providers. As a first test case for the DataCite mapping, HZB minted four DOIs with DataCite for HZB instruments: two beamlines at the Berlin Research Reactor BER-II<ref name="HZBE2Flat">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1698&typoid=37694 \|title=E2 Flat-Cone Diffractometer \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000001}}</ref><ref name="HZBE9Fine">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1702 \|title=E9 Fine Resolution Powder Diffractometer (FIREPOD) \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000002}}</ref>, one beamline at the synchrotron radiation source BESSY II<ref name="HZB_UE52">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1927 \|title=UE52_PGM Nano cluster trap \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000003}}</ref>, and one experimental station at BESSY II.<ref name="HZBNano">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1848 \|title=NanoclusterTrap \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000004}}</ref> The DOIs resolve to the respective instrument pages from the HZB instrument database, which already existed beforehand and were thus not created for this purpose. One particularity with these instruments is that they are custom-built by HZB. Thus, in the metadata "HZB" appears as Creator as well as Contributor, with property <tt>contributorType</tt> value "HostingInstitution." It is noteworthy that one of the DOIs uses the additional property <tt>fundingReference</tt> from the DataCite schema to acknowledge external funding that HZB received for upgrading the instrument. This property was not considered in the PIDINST schema, or in the DataCite mapping. HZB plans to continue the adoption and to mint DOIs for all its beamlines and experimental stations that are in user operation in the near future.

	BODC tested the ePIC implementation in web-published, sensor technical metadata descriptions encoded in the Open Geospatial Consortium’s (OGC) ~~SensorML21~~ open standards for conceptualizing and integrating real-world sensors. In an initial test case, a PID was minted for a Sea-Bird Scientific SBE37 Microcat regularly deployed on fixed-point moorings in the [https://projects.noc.ac.uk/pap/ Porcupine Abyssal Plain Sustained Observatory] (PAP-SO) in the north Atlantic. As seen in the handle record (Table 3), the implementation uses well-established, controlled vocabularies to facilitate adoption and (semantic) interoperability of the metadata record. The vocabularies are published by the [https://www.bodc.ac.uk/resources/products/web_services/vocab/ NERC Vocabulary Server] (NVS), which makes use of the World Wide Web Consortium’s (W3C) Simple Knowledge Organization System (SKOS).<ref name="IsaacSKOS09">{{cite web \|url=https://www.w3.org/TR/skos-primer/ \|title=SKOS Simple Knowledge Organization System Primer \|author=Isaac, A.; Summers, E. \|publisher=World Wide Web Consortium \|date=18 August 2009}}</ref> At BODC, each instrument’s technical description is published using a unique URL (e.g., https://linkedsystems.uk/system/instance/TOOL0022_2490/current/) identifying the instrument locally, which is included in data transmissions to identify the instrument that produced them. The respective Handle (e.g., http://hdl.handle.net/21.T11998/0000-001A-3905-F) resolves directly to the URL of the instrument’s technical description, which contains machine-readable metadata, such as the name, manufacturer and serial number. To enable cross-referencing, the Handle is added within the description as an identifier property labelled "Instrument persistent identifier" (Listing 1). In this way, redirection to the instrument’s SensorML URL enables globally unique identification of the instrument without costly changes to the existing publication infrastructure and data workflows.		BODC tested the ePIC implementation in web-published, sensor technical metadata descriptions encoded in the Open Geospatial Consortium’s (OGC) [https://www.ogc.org/standards/sensorml SensorML] open standards for conceptualizing and integrating real-world sensors. In an initial test case, a PID was minted for a Sea-Bird Scientific SBE37 Microcat regularly deployed on fixed-point moorings in the [https://projects.noc.ac.uk/pap/ Porcupine Abyssal Plain Sustained Observatory] (PAP-SO) in the north Atlantic. As seen in the handle record (Table 3), the implementation uses well-established, controlled vocabularies to facilitate adoption and (semantic) interoperability of the metadata record. The vocabularies are published by the [https://www.bodc.ac.uk/resources/products/web_services/vocab/ NERC Vocabulary Server] (NVS), which makes use of the World Wide Web Consortium’s (W3C) Simple Knowledge Organization System (SKOS).<ref name="IsaacSKOS09">{{cite web \|url=https://www.w3.org/TR/skos-primer/ \|title=SKOS Simple Knowledge Organization System Primer \|author=Isaac, A.; Summers, E. \|publisher=World Wide Web Consortium \|date=18 August 2009}}</ref> At BODC, each instrument’s technical description is published using a unique URL (e.g., https://linkedsystems.uk/system/instance/TOOL0022_2490/current/) identifying the instrument locally, which is included in data transmissions to identify the instrument that produced them. The respective Handle (e.g., http://hdl.handle.net/21.T11998/0000-001A-3905-F) resolves directly to the URL of the instrument’s technical description, which contains machine-readable metadata, such as the name, manufacturer and serial number. To enable cross-referencing, the Handle is added within the description as an identifier property labelled "Instrument persistent identifier" (Listing 1). In this way, redirection to the instrument’s SensorML URL enables globally unique identification of the instrument without costly changes to the existing publication infrastructure and data workflows.

	{\|		{\|
Line 600:		Line 600:

	==Discussion==		==Discussion==
			Rapid advances in technology means we are producing more instruments and data than ever. From simple thermistors, to large-scale synchrotrons, to global sensor observing networks, there is a growing need for innovation to address the management of these valuable assets and the data they produce. The proposed solution enables the persistent and consistent identification of instruments for citation, cross-linking, and retrieval purposes across local and global instrument facilities, networks, and data systems.

			There are many benefits to the proposed solution. It builds on existing infrastructure and is designed to facilitate easy identification. It comprises a persistent identifier and metadata schema with a list of core metadata properties chosen for accurate identification of the instrument and for setting it into context. Metadata includes the instrument’s name, a textual description, the manufacturer, the institution that owns or manages it, and references to other objects or entities that relate to the instrument. These metadata give meaning to the persistent identifier and are therefore registered with PID infrastructure.

			To make persistent identification of instruments across diverse communities practical, the PIDINST schema includes only a small set of common properties. As instruments are increasingly complex and specialized, technical metadata, such as configuration and calibration, are often extensive, dynamic, and inherently difficult to standardize. There is no common standard for this kind of technical metadata that would be meaningful for all experiment techniques across scientific disciplines. However, specific standards for particular scientific communities do exist or are evolving. One approach that has had some success in the earth and environmental sciences is SensorML. Together with the OGC's [https://www.ogc.org/standards/swecommon Sensor Web Enablement (SWE) Common Data Model Encoding Standard], SensorML provides a conceptual model as well as XML and JSON encodings for sensors and measurement processes metadata. In general, however, the lack of standardization prevents this metadata from being registered with PID infrastructure. Instead, detailed information including descriptive material, contact information, applications, technical data, and guidance for using the instrument may be provided on the landing page associated with the instrument identifier. Technical metadata may also be linked from the metadata registered with PID infrastructure using <tt>RelatedIdentifier</tt> with property <tt>relationType</tt> value "HasMetadata" to enable automatic retrieval.

			The PIDINST schema is designed to complement multidisciplinary best practices for property values. Many properties allow for soft-typing, giving users the ability to use values of their choice, such as free text or domain-specific standards. Property attributes enable users and machines to understand the context of the value (e.g., <tt>ownerIdentifier</tt>, <tt>ownerIdentifierType</tt>), again using free text or standards. A similar approach is used in the DataCite metadata schema. Domain-specific standards can vary among communities. For example, the SeaDataNet research infrastructure and SWE Marine Profiles group recommend controlled vocabularies and identifiers to annotate datasets and open standards related to instruments<ref name="KokkinakiSemant16">{{cite journal \|title=Semantically Enhancing SensorML with Controlled Vocabularies in the Marine Domain \|journal=Proceedings of the Geospatial Sensor Webs Conference 2016 \|author=Kokkinanki, A.; Darroch, L.; Buch, J. et al. \|pages=1–6 \|year=2016 \|url=http://ceur-ws.org/Vol-1762/Kokkinaki.pdf \|format=PDF}}</ref>, including the SeaVox Device Catalogue for instrument model designs, the BODC Parameter Usage Vocabulary for measured variables, and the European Directory of Marine Organisations (EDMO). Communities in the earth sciences have chosen to label measured parameters with Climate Forecast Standard Names. The PIDINST schema allows these communities to use property values of their choice. While soft-typing is practical towards multidisciplinary use, it does reduce interoperability because different communities use different standards for values as described above. However, with such heterogeneity and establishment, it is impractical to use one standard for all use cases. The use of identifiers with knowledge representation schemes (e.g., SKOS) goes some way to improving understanding between information systems and can be used in the schema shown in Listing 1. Thus, the PIDINST schema complements multidisciplinary best practices through soft-typing while facilitating the use of standards which can enhance interoperability, if desired.

			Another important goal for the PIDINST schema is to facilitate linking among instruments and journal articles, datasets, and other research objects. These links are made using <tt>RelatedIdentifier</tt> elements in the identifier metadata, and the relationships are described using <tt>relationType</tt> elements. For instance, the identifier metadata of the four previously mentioned HZB instruments registered with DataCite contain related identifiers with property <tt>relationType</tt> value "IsDescribedBy." Listing 2 provides an example. The relations point to journal articles that describe the instruments and provide technical details. These articles serve a similar purpose as “data papers”<ref name="CandelaData15">{{cite journal \|title=Data journals: A survey \|journal=JASIST \|author=Candela, L.; Castelli, D.; Manghi, P. et al. \|volume=66 \|issue=9 \|pages=1747–62 \|year=2015 \|doi=10.1002/asi.23358}}</ref>, i.e., articles that describe datasets, published in peer reviewed journals to provide recognition for dataset creation by means of an article. Thus, we term such articles “instrument papers.” To name an example, the [https://jlsrf.org/ Journal of large-scale research facilities] (JLSFR) publishes such articles.

			{\|
			\| STYLE="vertical-align:top;"\|
			{\| class="wikitable" border="1" cellpadding="5" cellspacing="0" width="50%"
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;" colspan="1"\|'''Listing 2.''' Snippet of DataCite metadata (https://api.datacite.org/dois/10.5442/NI000001) relating the HZB instrument “E2 – Flat-Cone Diffractometer” (https://doi.org/10.5442/NI000001) with a journal article describing the instrument (https://doi.org/10.17815/jlsrf-4-110)
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code>"relatedIdentifiers": [{</code><br />
			<code>"relationType":"IsDescribedBy",</code><br />
			<code>"relatedIdentifier":"10.17815/jlsrf-4-110",</code><br />
			<code>"relatedIdentifierType":"DOI"</code><br />
			<code>}]</code><br />
			\|-
			\|}
			\|}

			Together, instrument papers and landing pages provide important documentation that helps scientists and users more generally understand the instruments and how they have been used in scientific experiments. This documentation is designed to be read by humans. Structured metadata linked using persistent identifiers, on the other hand, enable machine readability and processing of information about instruments. These representations of information, for humans and for machines, are complementary.

	==References==		==References==

Shawndouglas: Saving and adding more.

2020-09-16T18:14:01Z

Saving and adding more.

← Older revision		Revision as of 18:14, 16 September 2020
Line 582:		Line 582:
	\|}		\|}
	\|}		\|}

			{\|
			\| STYLE="vertical-align:top;"\|
			{\| class="wikitable" border="1" cellpadding="5" cellspacing="0" width="100%"
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;" colspan="1"\|'''Listing 1.''' SensorML metadata snippet showing the embedding of the instrument’s (Handle) persistent identifier
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code><sml:identifier></code><br />
			<code><sml:Term></code><br />
			<code><sml:label>Instrument persistent identifier</sml:label></code><br />
			<code><sml:value>http://hdl.handle.net/21.T11998/0000-001A-3904-0</sml:value></code><br />
			<code></sml:Term></code><br />
			<code></sml:identifier></code><br />
			\|-
			\|}
			\|}

			==Discussion==



	==References==		==References==

Shawndouglas: Saving and adding more.

2020-09-16T18:08:36Z

Saving and adding more.

← Older revision		Revision as of 18:08, 16 September 2020
Line 515:		Line 515:
	<code>"ownerContact":"louise.darroch@bodc.ac.uk",</code><br />		<code>"ownerContact":"louise.darroch@bodc.ac.uk",</code><br />
	<code>"ownerIdentifier":{</code><br />		<code>"ownerIdentifier":{</code><br />
	<code>"ownerIdentifierValue":~~</code><br />~~		<code>"ownerIdentifierValue":"http://vocab.nerc.ac.uk/collection/B75/current/ORG00009/",</code><br />
	~~      <code>~~"http://vocab.nerc.ac.uk/collection/B75/current/ORG00009/",</code><br />
	<code>"ownerIdentifierType":"URL"</code><br />		<code>"ownerIdentifierType":"URL"</code><br />
	<code>}</code><br />		<code>}</code><br />
			<code>}</code><br />
			<code>}]</code>
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|[http://hdl.handle.net/21.T11148/1f3e82ddf0697a497432 21.T11148/1f3e82ddf0697a497432] (<tt>Manufacturer</tt>)
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code>[{</code><br />
			<code>"Manufacturer":{</code><br />
			<code>"manufacturerName":"Sea-Bird Scientific",</code><br />
			<code>"modelName":"SBE 37-IM",</code><br />
			<code>"manufacturerIdentifier":{</code><br />
			<code>"manufacturerIdentifierValue":"http://vocab.nerc.ac.uk/collection/L35/current/MAN0013/",</code><br />
			<code>"manufacturerIdentifierType":"URL"</code><br />
			<code>}</code><br />
			<code>}</code><br />
			<code>}]</code>
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|[http://hdl.handle.net/21.T11148/55f8ebc805e65b5b71dd 21.T11148/55f8ebc805e65b5b71dd] (<tt>Description</tt>)
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code>A high accuracy conductivity and temperature recorder with an optional pressure sensor designed for deployment on moorings. The IM model has an inductive modem for real-time data transmission plus internal flash memory data storage.</code>
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|[http://hdl.handle.net/21.T11148/f76ad9d0324302fc47dd 21.T11148/f76ad9d0324302fc47dd] (<tt>InstrumentType</tt>)
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code>http://vocab.nerc.ac.uk/collection/L22/current/TOOL0022/</code>
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|[http://hdl.handle.net/21.T11148/72928b84e060d491ee41 21.T11148/72928b84e060d491ee41] (<tt>MeasuredVariable</tt>)
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code>[{</code><br />
			<code>"MeasuredVariable":{</code><br />
			<code>"VariableMeasured":"http://vocab.nerc.ac.uk/collection/P01/current/CNDCPR01/"</code><br />
			<code>} },{</code><br />
			<code>"MeasuredVariable":{</code><br />
			<code>"VariableMeasured":"http://vocab.nerc.ac.uk/collection/P01/current/PSALPR01/"</code><br />
			<code>} },{</code><br />
			<code>"MeasuredVariable":{</code><br />
			<code>"VariableMeasured":"http://vocab.nerc.ac.uk/collection/P01/current/TEMPPR01/"</code><br />
			<code>} },{</code><br />
			<code>"MeasuredVariable":{</code><br />
			<code>"VariableMeasured":"http://vocab.nerc.ac.uk/collection/P01/current/PREXMCAT/"</code><br />
			<code>}</code><br />
			<code>}]</code><br />
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|[http://hdl.handle.net/21.T11148/22c62082a4d2d9ae2602 21.T11148/22c62082a4d2d9ae2602] (<tt>Date</tt>)
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code>[{</code><br />
			<code>"date":{</code><br />
			<code>"date":"1999-11-01",</code><br />
			<code>"dateType":"Commissioned"</code><br />
			<code>}</code><br />
			<code>}]</code><br />
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|[http://hdl.handle.net/21.T11148/eb3c713572f681e6c4c3 21.T11148/eb3c713572f681e6c4c3] (<tt>AlternateIdentifiers</tt>)
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code>[{</code><br />
			<code>"AlternateIdentifier":{</code><br />
			<code>"AlternateIdentifierValue":"2490",</code><br />
			<code>"alternateIdentifierType":"serialNumber"</code><br />
			<code>}</code><br />
			<code>}]</code><br />
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|[http://hdl.handle.net/21.T11148/178fb558abc755ca7046 21.T11148/178fb558abc755ca7046] (<tt>RelatedIdentifiers</tt>)
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code>[{</code><br />
			<code>"RelatedIdentifier":{</code><br />
			<code>"RelatedIdentifierValue":"https://www.bodc.ac.uk/data/documents/nodb/pdf/37imbrochurejul08.pdf",</code><br />
			<code>"RelatedIdentifierType":"URL",</code><br />
			<code>"relationType":"IsDescribedBy "</code><br />
	<code>}</code><br />		<code>}</code><br />
	<code>}]</code><br />		<code>}]</code><br />

Shawndouglas: Saving and adding more.

2020-09-16T17:39:42Z

Saving and adding more.

← Older revision		Revision as of 17:39, 16 September 2020
Line 486:		Line 486:
	Both the DataCite mapping and the ePIC implementation of the PIDINST schema have been prototypically tested with institutional instrument providers. As a first test case for the DataCite mapping, HZB minted four DOIs with DataCite for HZB instruments: two beamlines at the Berlin Research Reactor BER-II<ref name="HZBE2Flat">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1698&typoid=37694 \|title=E2 Flat-Cone Diffractometer \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000001}}</ref><ref name="HZBE9Fine">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1702 \|title=E9 Fine Resolution Powder Diffractometer (FIREPOD) \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000002}}</ref>, one beamline at the synchrotron radiation source BESSY II<ref name="HZB_UE52">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1927 \|title=UE52_PGM Nano cluster trap \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000003}}</ref>, and one experimental station at BESSY II.<ref name="HZBNano">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1848 \|title=NanoclusterTrap \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000004}}</ref> The DOIs resolve to the respective instrument pages from the HZB instrument database, which already existed beforehand and were thus not created for this purpose. One particularity with these instruments is that they are custom-built by HZB. Thus, in the metadata "HZB" appears as Creator as well as Contributor, with property <tt>contributorType</tt> value "HostingInstitution." It is noteworthy that one of the DOIs uses the additional property <tt>fundingReference</tt> from the DataCite schema to acknowledge external funding that HZB received for upgrading the instrument. This property was not considered in the PIDINST schema, or in the DataCite mapping. HZB plans to continue the adoption and to mint DOIs for all its beamlines and experimental stations that are in user operation in the near future.		Both the DataCite mapping and the ePIC implementation of the PIDINST schema have been prototypically tested with institutional instrument providers. As a first test case for the DataCite mapping, HZB minted four DOIs with DataCite for HZB instruments: two beamlines at the Berlin Research Reactor BER-II<ref name="HZBE2Flat">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1698&typoid=37694 \|title=E2 Flat-Cone Diffractometer \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000001}}</ref><ref name="HZBE9Fine">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1702 \|title=E9 Fine Resolution Powder Diffractometer (FIREPOD) \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000002}}</ref>, one beamline at the synchrotron radiation source BESSY II<ref name="HZB_UE52">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1927 \|title=UE52_PGM Nano cluster trap \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000003}}</ref>, and one experimental station at BESSY II.<ref name="HZBNano">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1848 \|title=NanoclusterTrap \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000004}}</ref> The DOIs resolve to the respective instrument pages from the HZB instrument database, which already existed beforehand and were thus not created for this purpose. One particularity with these instruments is that they are custom-built by HZB. Thus, in the metadata "HZB" appears as Creator as well as Contributor, with property <tt>contributorType</tt> value "HostingInstitution." It is noteworthy that one of the DOIs uses the additional property <tt>fundingReference</tt> from the DataCite schema to acknowledge external funding that HZB received for upgrading the instrument. This property was not considered in the PIDINST schema, or in the DataCite mapping. HZB plans to continue the adoption and to mint DOIs for all its beamlines and experimental stations that are in user operation in the near future.

			BODC tested the ePIC implementation in web-published, sensor technical metadata descriptions encoded in the Open Geospatial Consortium’s (OGC) SensorML21 open standards for conceptualizing and integrating real-world sensors. In an initial test case, a PID was minted for a Sea-Bird Scientific SBE37 Microcat regularly deployed on fixed-point moorings in the [https://projects.noc.ac.uk/pap/ Porcupine Abyssal Plain Sustained Observatory] (PAP-SO) in the north Atlantic. As seen in the handle record (Table 3), the implementation uses well-established, controlled vocabularies to facilitate adoption and (semantic) interoperability of the metadata record. The vocabularies are published by the [https://www.bodc.ac.uk/resources/products/web_services/vocab/ NERC Vocabulary Server] (NVS), which makes use of the World Wide Web Consortium’s (W3C) Simple Knowledge Organization System (SKOS).<ref name="IsaacSKOS09">{{cite web \|url=https://www.w3.org/TR/skos-primer/ \|title=SKOS Simple Knowledge Organization System Primer \|author=Isaac, A.; Summers, E. \|publisher=World Wide Web Consortium \|date=18 August 2009}}</ref> At BODC, each instrument’s technical description is published using a unique URL (e.g., https://linkedsystems.uk/system/instance/TOOL0022_2490/current/) identifying the instrument locally, which is included in data transmissions to identify the instrument that produced them. The respective Handle (e.g., http://hdl.handle.net/21.T11998/0000-001A-3905-F) resolves directly to the URL of the instrument’s technical description, which contains machine-readable metadata, such as the name, manufacturer and serial number. To enable cross-referencing, the Handle is added within the description as an identifier property labelled "Instrument persistent identifier" (Listing 1). In this way, redirection to the instrument’s SensorML URL enables globally unique identification of the instrument without costly changes to the existing publication infrastructure and data workflows.

			{\|
			\| STYLE="vertical-align:top;"\|
			{\| class="wikitable" border="1" cellpadding="5" cellspacing="0" width="80%"
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;" colspan="2"\|'''Table 3.''' Handle record of instrument identifier http://hdl.handle.net/21.T11998/0000-001A-3905-F displaying instrument metadata compliant with the PIDINST schema as implemented by ePIC
			\|-
			! style="background-color:#e2e2e2; padding-left:10px; padding-right:10px;"\|Type
			! style="background-color:#e2e2e2; padding-left:10px; padding-right:10px;"\|Data
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|URL
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code>https://linkedsystems.uk/system/instance/TOOL0022_2490/current/</code>
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|[http://hdl.handle.net/21.T11148/8eb858ee0b12e8e463a5 21.T11148/8eb858ee0b12e8e463a5] (<tt>Identifier</tt>)
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code>{ "identifierValue":"http://hdl.handle.net/21.T11998/0000-001A-3905-F", "identiferType":"MeasuringInstrument" }</code>
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|[http://hdl.handle.net/21.T11148/9a15a4735d4bda329d80 21.T11148/9a15a4735d4bda329d80] (<tt>LandingPage</tt>)
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code>https://linkedsystems.uk/system/instance/TOOL0022_2490/current/</code>
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|[http://hdl.handle.net/21.T11148/709a23220f2c3d64d1e1 21.T11148/709a23220f2c3d64d1e1] (<tt>Name</tt>)
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code>Sea-Bird SBE 37-IM MicroCAT C-T Sensor</code>
			\|-
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|[http://hdl.handle.net/21.T11148/4eaec4bc0f1df68ab2a7 21.T11148/4eaec4bc0f1df68ab2a7] (<tt>Owner</tt>)
			\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<code>[{</code><br />
			<code>"Owner": {</code><br />
			<code>"ownerName":"National Oceanography Centre",</code><br />
			<code>"ownerContact":"louise.darroch@bodc.ac.uk",</code><br />
			<code>"ownerIdentifier":{</code><br />
			<code>"ownerIdentifierValue":</code><br />
			<code>"http://vocab.nerc.ac.uk/collection/B75/current/ORG00009/",</code><br />
			<code>"ownerIdentifierType":"URL"</code><br />
			<code>}</code><br />
			<code>}</code><br />
			<code>}]</code><br />
			\|-
			\|}
			\|}

	==References==		==References==

Shawndouglas: Saving and adding more.

2020-09-16T17:05:24Z

Saving and adding more.

← Older revision		Revision as of 17:05, 16 September 2020
Line 479:		Line 479:
	* add a Series property, which would solve the model name issue<ref name="RKrahlAddASer19">{{cite web \|url=https://github.com/datacite/schema/issues/72 \|title=Add a "Series" property #72 \|author=RKrahl \|work=GitHub - datacite / schema \|date=28 August 2019}}</ref>; and		* add a Series property, which would solve the model name issue<ref name="RKrahlAddASer19">{{cite web \|url=https://github.com/datacite/schema/issues/72 \|title=Add a "Series" property #72 \|author=RKrahl \|work=GitHub - datacite / schema \|date=28 August 2019}}</ref>; and
	* add "Name" to the controlled list of values for <tt>titleType</tt>.<ref name="RKrahlAddName19">{{cite web \|url=https://github.com/datacite/schema/issues/73 \|title=Add "Name" to controlled list of values for "titleType" #73 \|author=RKrahl \|work=GitHub - datacite / schema \|date=28 August 2019}}</ref>		* add "Name" to the controlled list of values for <tt>titleType</tt>.<ref name="RKrahlAddName19">{{cite web \|url=https://github.com/datacite/schema/issues/73 \|title=Add "Name" to controlled list of values for "titleType" #73 \|author=RKrahl \|work=GitHub - datacite / schema \|date=28 August 2019}}</ref>

			Amending the DataCite schema to address these issues would further increase the usability of the DataCite schema for instruments.

			Collaboration with ePIC resulted in a prototypical implementation of the PIDINST schema in the ePIC infrastructure. ePIC provides a [https://dtr.pidconsortium.net/ Data Type Registry infrastructure] that enables the definition and description of metadata schemata in a hierarchical way<ref name="SchwardmannAuto16">{{cite journal \|title=Automated schema extraction for PID information types \|journal=Proceedings of the 2016 IEEE International Conference on Big Data \|author=Schwardmann, U. \|pages=3036-3044 \|year=2016 \|doi=10.1109/BigData.2016.7840957}}</ref>, such that all definitions get a unique reference by a Handle. This framework is flexible enough for the definition of most possible metadata schemata. The PIDINST schema is hierarchical and contains at the first level a number of elements which contain substructures such as Owners, which is a list of objects containing <tt>ownerName</tt>, <tt>ownerContact</tt>, etc. The complete prototypical definition of the PIDINST schema is given under the name "Properties-PID-instruments" (see [http://dtr-test.pidconsortium.eu/objects/21.T11148/17ce618137e697852ea6 here], for example). This definition contains all first-level metadata elements of the PIDINST schema. Hence, a PIDINST metadata description can be given as a single object containing all first-level metadata elements as subobjects or, for instance, as a collection of the first-level metadata elements. Additionally, ePIC provides the possibility to include small metadata elements into the Handle record itself, giving useful information already at the reference level. This kind of metadata is called PID information type and is particularly useful for digital objects where metadata rather than data is of major interest.

			Both the DataCite mapping and the ePIC implementation of the PIDINST schema have been prototypically tested with institutional instrument providers. As a first test case for the DataCite mapping, HZB minted four DOIs with DataCite for HZB instruments: two beamlines at the Berlin Research Reactor BER-II<ref name="HZBE2Flat">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1698&typoid=37694 \|title=E2 Flat-Cone Diffractometer \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000001}}</ref><ref name="HZBE9Fine">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1702 \|title=E9 Fine Resolution Powder Diffractometer (FIREPOD) \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000002}}</ref>, one beamline at the synchrotron radiation source BESSY II<ref name="HZB_UE52">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1927 \|title=UE52_PGM Nano cluster trap \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000003}}</ref>, and one experimental station at BESSY II.<ref name="HZBNano">{{cite web \|url=https://www.helmholtz-berlin.de/pubbin/igama_output?modus=einzel&sprache=en&gid=1848 \|title=NanoclusterTrap \|publisher=Helmholtz Zentrum Berlin \|doi=10.5442/NI000004}}</ref> The DOIs resolve to the respective instrument pages from the HZB instrument database, which already existed beforehand and were thus not created for this purpose. One particularity with these instruments is that they are custom-built by HZB. Thus, in the metadata "HZB" appears as Creator as well as Contributor, with property <tt>contributorType</tt> value "HostingInstitution." It is noteworthy that one of the DOIs uses the additional property <tt>fundingReference</tt> from the DataCite schema to acknowledge external funding that HZB received for upgrading the instrument. This property was not considered in the PIDINST schema, or in the DataCite mapping. HZB plans to continue the adoption and to mint DOIs for all its beamlines and experimental stations that are in user operation in the near future.



	==References==		==References==

Shawndouglas: Saving and adding more.

2020-09-16T16:21:23Z

Saving and adding more.

Shawndouglas: Saving and adding more.

2020-09-16T16:04:50Z

Saving and adding more.

Show changes

Shawndouglas: Saving and adding more.

2020-09-15T23:27:07Z

Saving and adding more.

Shawndouglas: Saving and adding more.

2020-09-15T23:22:32Z

Saving and adding more.

Show changes

← Older revision		Revision as of 16:21, 16 September 2020
Line 200:		Line 200:
	{\| class="wikitable" border="1" cellpadding="5" cellspacing="0" width="70%"		{\| class="wikitable" border="1" cellpadding="5" cellspacing="0" width="70%"
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;" colspan="5"\|'''Table 2.''' Overview of the collected metadata, analysis of common metadata and mapping of properties onto the PIDINST schema		\| style="background-color:white; padding-left:10px; padding-right:10px;" colspan="5"\|'''Table 2.''' Overview of the collected metadata, analysis of common metadata and mapping of properties onto the PIDINST schema. <sup>*</sup> = Properties common to at least five use cases
	\|-		\|-
	! style="background-color:#e2e2e2; padding-left:10px; padding-right:10px;"\|#		! style="background-color:#e2e2e2; padding-left:10px; padding-right:10px;"\|#
Line 208:		Line 208:
	! style="background-color:#e2e2e2; padding-left:10px; padding-right:10px;"\|Schema		! style="background-color:#e2e2e2; padding-left:10px; padding-right:10px;"\|Schema
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|1		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|1 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Persistent identifier		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Persistent identifier
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Identification		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Identification
Line 232:		Line 232:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|5		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|5 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument Name		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument Name
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument
Line 238:		Line 238:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<tt>Name</tt>		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|<tt>Name</tt>
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|6		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|6 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument Description		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument Description
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument
Line 250:		Line 250:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|8		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|8 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument Type		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument Type
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument
Line 274:		Line 274:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|12		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|12 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument Owner		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Instrument Owner
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Owner		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Owner
Line 334:		Line 334:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|22		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|22 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Manufacturer		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Manufacturer
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Manufacturer		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Manufacturer
Line 352:		Line 352:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|25		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|25 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Date		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Date
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Date		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Date
Line 370:		Line 370:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|~~282~~		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|28
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Capability Type		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Capability Type
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Capability		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Capability
Line 469:		Line 469:
	\|}		\|}

			While the 43 properties collected may suggest high heterogeneity, only a few can be considered common. Properties common to at least five use cases (50%) are Persistent Identifier, Instrument Name, Instrument Description, Instrument Type, Instrument Owner, Manufacturer, and Date (marked with a <sup>*</sup> in Table 2, Column 1). Table 2 also maps the collected properties onto the proposed PIDINST schema, which is [https://github.com/rdawg-pidinst/schema/blob/master/schema.rst published on GitHub]. As we can see, there is a mapping for all common properties. We have included additional schema properties which the WG considered important or useful even if they were not common among the considered use cases. Most notably, we include <tt>RelatedIdentifier</tt> as a flexible technique to represent identifiers of entities related to the instrument, such as articles describing the instrument or the previous version of the instrument.

			PIDINST has actively supported the adoption and implementation of the schema with two stakeholders: (1) PID infrastructures, in particular DataCite and ePIC, and (2) institutional instrument providers, in particular HZB (Helmholtz-Zentrum Berlin für Materialien und Energie) and BODC (British Oceanographic Data Centre).

			Collaboration with DataCite resulted in a mapping of the PIDINST schema with the DataCite schema version 4.3. This mapping is also [https://github.com/rdawg-pidinst/schema/blob/master/schema-datacite.rst published on GitHub]. It shows that most instrument metadata of the PIDINST schema can be represented adequately also using the DataCite schema, even though some of the definitions need to be stretched. Still, we identified a few shortcomings with this mapping. Most notably, the DataCite schema has no suitable property for the model name. Furthermore, the controlled list of values for the <tt>resourceTypeGeneral</tt> property lacks a suitable value for "Instrument." We submitted corresponding issues at the GitHub repository of the DataCite schema. Specifically, we suggest to:

			* add "Instrument" to the controlled list of values for <tt>resourceTypeGeneral</tt><ref name="RKrahlAddInst19">{{cite web \|url=https://github.com/datacite/schema/issues/70 \|title=Add "Instrument" to controlled list of values for "resourceTypeGeneral" #70 \|author=RKrahl \|work=GitHub - datacite / schema \|date=28 August 2019}}</ref>;
			* add a value indicating “was used in” to <tt>relationType</tt> to relate an instrument with events<ref name="RKrahlAddAVal19">{{cite web \|url=https://github.com/datacite/schema/issues/71 \|title=Add a value indicating "was used in" to "relationType" #71 \|author=RKrahl \|work=GitHub - datacite / schema \|date=28 August 2019}}</ref>;
			* add a Series property, which would solve the model name issue<ref name="RKrahlAddASer19">{{cite web \|url=https://github.com/datacite/schema/issues/72 \|title=Add a "Series" property #72 \|author=RKrahl \|work=GitHub - datacite / schema \|date=28 August 2019}}</ref>; and
			* add "Name" to the controlled list of values for <tt>titleType</tt>.<ref name="RKrahlAddName19">{{cite web \|url=https://github.com/datacite/schema/issues/73 \|title=Add "Name" to controlled list of values for "titleType" #73 \|author=RKrahl \|work=GitHub - datacite / schema \|date=28 August 2019}}</ref>

	==References==		==References==

← Older revision		Revision as of 23:27, 15 September 2020
Line 77:		Line 77:
	{\| class="wikitable" border="1" cellpadding="5" cellspacing="0" width="70%"		{\| class="wikitable" border="1" cellpadding="5" cellspacing="0" width="70%"
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;" colspan="6"\|'''Table 1.''' Overview of the use cases collected by RDA WG PIDINST. "Submission" is the month of first use case submission by authors to the WG. "Completed" is the month during which the use case was completed with the required metadata. In some instances, the metadata was provided later. For UC4, the authors didn’t provide the metadata; the use case was thus not completed (N/A). For UC1, UC5, UC8, and UC15 the metadata was provided after October 2018; these use cases were thus not considered in the metadata analysis.		\| style="background-color:white; padding-left:10px; padding-right:10px;" colspan="6"\|'''Table 1.''' Overview of the use cases collected by RDA WG PIDINST. "Submission" is the month of first use case submission by authors to the WG. "Completed" is the month during which the use case was completed with the required metadata. In some instances, the metadata was provided later. For UC4, the authors didn’t provide the metadata; the use case was thus not completed (N/A). For UC1, UC5, UC8, and UC15 the metadata was provided after October 2018; these use cases were thus not considered in the metadata analysis. <sup>*</sup> = Use cases used in analysis on October 2018
	\|-		\|-
	! style="background-color:#e2e2e2; padding-left:10px; padding-right:10px;"\|Use case		! style="background-color:#e2e2e2; padding-left:10px; padding-right:10px;"\|Use case
Line 93:		Line 93:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|03/2019		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|03/2019
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|2		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|2 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Helmholtz-Zentrum Berlin für Materialien und Energie		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Helmholtz-Zentrum Berlin für Materialien und Energie
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Multidisciplinary		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Multidisciplinary
Line 100:		Line 100:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|06/2018		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|06/2018
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|3		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|3 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|National Imaging Facility, Australia		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|National Imaging Facility, Australia
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Multidisciplinary		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Multidisciplinary
Line 121:		Line 121:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|12/2018		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|12/2018
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|6		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|6 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Marine Sensor Web Enablement Working Group		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Marine Sensor Web Enablement Working Group
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Earth sciences		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Earth sciences
Line 128:		Line 128:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|05/2018		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|05/2018
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|7		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|7 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|ORCID		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|ORCID
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Publisher		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Publisher
Line 142:		Line 142:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|12/2018		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|12/2018
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|9		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|9 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|British Oceanographic Data Centre		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|British Oceanographic Data Centre
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Earth sciences		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Earth sciences
Line 149:		Line 149:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|07/2018		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|07/2018
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|10		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|10 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|European Southern Observatory		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|European Southern Observatory
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Astronomy		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Astronomy
Line 156:		Line 156:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|08/2018		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|08/2018
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|11		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|11 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Forschungszentrum Jülich, Central Library (literature supplier for large-scale research facilities)		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Forschungszentrum Jülich, Central Library (literature supplier for large-scale research facilities)
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Publisher		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Publisher
Line 163:		Line 163:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|09/2018		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|09/2018
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|12		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|12 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|PANGAEA, Data Publisher for Earth & Environmental Science		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|PANGAEA, Data Publisher for Earth & Environmental Science
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Publisher		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Publisher
Line 170:		Line 170:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|09/2018		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|09/2018
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|13		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|13 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Permanent Service for Mean Sea Level		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Permanent Service for Mean Sea Level
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Earth sciences		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Earth sciences
Line 177:		Line 177:
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|10/2018		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|10/2018
	\|-		\|-
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|14		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|14 <sup>*</sup>
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|LTER-Europe		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|LTER-Europe
	\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Earth sciences		\| style="background-color:white; padding-left:10px; padding-right:10px;"\|Earth sciences
Line 193:		Line 193:
	\|}		\|}
	\|}		\|}

			Performed in October 2018, we used the metadata of 10 then-completed use cases (marked with a <sup>*</sup> in Table 1, Column 1) in an analysis that identified, organized, and harmonized the common properties. We tabulated properties, harmonized their names, counted property occurrence, and grouped properties into the following 10 categories: Identification, Instrument, Model, Owner, Manufacturer, Date, Capability, Output, Related Instrument, and Publisher. Table 2 summarizes the analysis of metadata common to the use cases.