Skip to content

Latest commit

 

History

History
228 lines (168 loc) · 41.9 KB

README.md

File metadata and controls

228 lines (168 loc) · 41.9 KB

RDA DMP Common Standard for machine-actionable Data Management Plans

About this document

This is a metadata application profile to provide basic interoperability between systems producing or consuming machine-actionable data management plans (maDMPS). Further fields can be added in specific deployments, but they do not guarantee interoperability. DMP tools can use any other fields in their internal data models.

This application profile is intended to cover a wide range of use cases and does not set any business (e.g. funder specific) requirements. It represents information over the whole DMP lifecycle.

For more information see examples, FAQ and useful links to consultations, documents, tools, prototypes, etc. developed by the working group.

DMP

Provides high level information about the DMP, e.g. its title, modification date, etc. It is the root of this application profile. The majority of its fields are mandatory.

Project

Describes the project associated with the DMP, if applicable. It can be used to describe any type of project: that is, not only funded projects, but also internal projects, PhD theses, etc.

Funding

For specifying details on funded projects, e.g. NSF of EC funded projects.

Contact

Specifies the party which can provide any information on the DMP. This is not necessarily the DMP creator, and can be a person or an organisation.

Contributor

For listing all parties involved in the process of the data management described by this DMP, and those parties involved in the creation and management of the DMP itself.

Cost

Provides a list of costs related to data management.

Dataset

This follows the defintion of Dataset in the W3C DCAT specification. Dataset can be understood as a logical entity depicting data, e.g. raw data. It provides high level information about the data. The granularity of dataset depends on a specific setting. In edge cases it can be a file, but also a collection of files in different formats. See FAQ for more details.

Distribution

The term "distribution" used here is as defined by the very widely used W3C DCAT metadata application profile. It is used to mean a particular instance of a dataset that has been, or is intended to be, made available in some fashion. It is important to separates the logical notion of a "dataset" from its distributions, of which there may be several, especially to attach more specific metadata properties such as "size" and "license". The lifecycle of the DMP has no particular bearing on this, and a "distribution" may be defined even if the DMP is never actually realised.

License

Used to indicate the license under which data (each specific Distribution) will be made available. It also allows for modelling embargoes. See FAQ for more details.

Host

Provides information on the system where data is stored. It can be used to provide details on a repository where data is deposited, e.g. a Core Trust Seal certified repository located in Europe that uses DOIs. It can also provide details on systems where data is stored and processed during research, e.g. a high performance computer that uses fast storage with two daily backups.

Security and Privacy

Used to indicate any specific requirements related to security and privacy of a specific dataset, e.g. to indicate that data is not anonymized.

Technical Resource

For specifying equipment needed/used to create or process the data, e.g. a microscope, etc.

Metadata

Provides a pointer to a metadata standard used to describe the data. It does not contain any actual metadata relating to the dataset.

Structure


Properties in 'contact'

NameDescriptionData TypeCardinalityExample Value
contact_idIdentifier for a contact personNested Data Structure1
mboxE-mail addressString1cc@example.com
nameName of the contact personString1Charlie Chaplin

Properties in 'contact_id'

NameDescriptionData TypeCardinalityExample Value
identifier String1
typeIdentifier type
Allowed Values:
  • orcid
  • isni
  • openid
  • other
Term from Controlled Vocabulary1orcid

Properties in 'contributor'

NameDescriptionData TypeCardinalityExample Value
contributor_id Nested Data Structure1
mboxMail addressString0..1john@smith.com
nameNameString1John Smith
roleType of contributorString1..nData Steward

Properties in 'contributor_id'

NameDescriptionData TypeCardinalityExample Value
identifierIdentifier for a contact personString1http://orcid.org/0000-0000-0000-0000
typeIdentifier type
Allowed Values:
  • orcid
  • isni
  • openid
  • other
Term from Controlled Vocabulary1orcid

Properties in 'cost'

NameDescriptionData TypeCardinalityExample Value
currency_codeAllowed values defined by ISO 4217.Term from Controlled Vocabulary0..1EUR
descriptionDescriptionString0..1Costs for maintaining....
titleTitleString1Storage and backup
valueValueNumber0..11000

Properties in 'dataset'

NameDescriptionData TypeCardinalityExample Value
data_quality_assuranceData Quality AssuranceString0..nWe use file naming convention...
dataset_idDataset IDNested Data Structure1
descriptionDescription is a property in both Dataset and Distribution, in compliance with W3C DCAT. In some cases these might be identical, but in most cases the Dataset represents a more abstract concept, while the distribution can point to a specific file.String0..1Field observation
distributionTo provide technical information on a specific instance of data.Nested Data Structure0..n
issuedIssued. Encoded using the relevant ISO 8601 Date and Time compliant stringDate0..12019-06-30
keywordKeywordString0..nkeyword 1, keyword 2
languageLanguage of the dataset expressed using ISO 639-3Term from Controlled Vocabulary0..1eng
metadataTo describe metadata standards used. Nested Data Structure0..n
personal_data
Allowed Values:
  • yes
  • no
  • unknown
Term from Controlled Vocabulary1unknown
preservation_statementPreservation StatementString0..1Must be preserved to enable...
security_and_privacyTo list all issues and requirements related to security and privacyNested Data Structure0..n
sensitive_data
Allowed Values:
  • yes
  • no
  • unknown
Term from Controlled Vocabulary1unknown
technical_resourceTo list all technical resources needed to implement a DMPNested Data Structure0..n
titleTitle is a property in both Dataset and Distribution, in compliance with W3C DCAT. In some cases these might be identical, but in most cases the Dataset represents a more abstract concept, while the distribution can point to a specific file.String1Fast car images
typeIf appropriate, type according to: DataCite and/or COAR dictionary. Otherwise use the common name for the type, e.g. raw data, software, survey, etc. https://schema.datacite.org/meta/kernel-4.1/doc/DataCite-MetadataKernel_v4.1.pdf http://vocabularies.coar-repositories.org/pubby/resource_type.htmlString0..1image

Properties in 'dataset_id'

NameDescriptionData TypeCardinalityExample Value
identifierIdentifier for a datasetString1https://hdl.handle.net/11353/10.923628
typeIdentifier type
Allowed Values:
  • handle
  • doi
  • ark
  • url
  • other
Term from Controlled Vocabulary1handle

Properties in 'distribution'

NameDescriptionData TypeCardinalityExample Value
access_urlA URL of the resource that gives access to a distribution of the dataset. e.g. landing page.URI0..1http://some.repo...
available_untilIndicates how long this distribution will be/ should be available. Encoded using the relevant ISO 8601 Date and Time compliant stringDate0..12030-06-30
byte_sizeByte SizeNumber0..1690000
data_accessIndicates access mode for data.
Allowed Values:
  • open
  • shared
  • closed
Term from Controlled Vocabulary1open
descriptionDescription is a property in both Dataset and Distribution, in compliance with W3C DCAT. In some cases these might be identical, but in most cases the Dataset represents a more abstract concept, while the distribution can point to a specific file.String0..1Best quality data before resizing
download_urlThe URL of the downloadable file in a given format. E.g. CSV file or RDF file.URI0..1http://some.repo.../download/...
formatFormat according to: https://www.iana.org/assignments/media-types/media-types.xhtml if appropriate, otherwise use the common name for this formatString0..nimage/tiff
hostTo provide information on quality of service provided by infrastructure (e.g. repository) where data is storedNested Data Structure0..1
licenseTo list all licenses applied to a specific distribution of data.Nested Data Structure0..n
titleTitle is a property in both Dataset and Distribution, in compliance with W3C DCAT. In some cases these might be identical, but in most cases the Dataset represents a more abstract concept, while the distribution can point to a specific file.String1Full resolution images

Properties in 'dmp'

NameDescriptionData TypeCardinalityExample Value
contactContact person for a DMPNested Data Structure1
contributorTo list people that play role in data management related to this DMP, e.g. resoponsible for performing actions described in this DMP.Nested Data Structure0..n
costTo list costs related to data management. Providing multiple instances of a 'Cost' allows to break down costs into details. Providing one 'Cost' instance allows to provide one aggregated sum.Nested Data Structure0..n
createdDate and time of the first version of a DMP. Must not be changed in subsequent DMPs. Encoded using the relevant ISO 8601 Date and Time compliant stringDateTime12019-03-13T13:13:00
datasetTo describe data on a non-technical level.Nested Data Structure1..n
descriptionTo provide any free-form text information on a DMPString0..1This DMP is for our new project
dmp_idIdentifier for the DMP itselfNested Data Structure1
ethical_issues_descriptionTo describe ethical issues directly in a DMPString0..1There are ethical issues, because...
ethical_issues_existTo indicate whether there are ethical issues related to data that this DMP describes.
Allowed Values:
  • yes
  • no
  • unknown
Term from Controlled Vocabulary1yes
ethical_issues_reportTo indicate where a protocol from a meeting with an ethical commitee can be foundURI0..1http://report.location
languageLanguage of the DMP expressed using ISO 639-3Term from Controlled Vocabulary1eng
modifiedMust be set each time DMP is modified. Indicates DMP version. Encoded using the relevant ISO 8601 Date and Time compliant stringDateTime12020-03-14T10:53:49
projectProject related to a DMPNested Data Structure0..n
titleTitle of a DMPString1DMP for our new project

Properties in 'dmp_id'

NameDescriptionData TypeCardinalityExample Value
identifierIdentifier for a DMPString1https://doi.org/10.1371/journal.pcbi.1006750
typeIdentifier type
Allowed Values:
  • handle
  • doi
  • ark
  • url
  • other
Term from Controlled Vocabulary1doi

Properties in 'funder_id'

NameDescriptionData TypeCardinalityExample Value
identifierFunder ID, recommended to use CrossRef Funder Registry. See: https://www.crossref.org/services/funder-registry/String1501100002428
typeIdentifier type
Allowed Values:
  • fundref
  • url
  • other
Term from Controlled Vocabulary1fundref

Properties in 'funding'

NameDescriptionData TypeCardinalityExample Value
funder_idFunder ID of the associated projectNested Data Structure1
funding_statusTo express different phases of project lifecycle.
Allowed Values:
  • planned
  • applied
  • granted
  • rejected
Term from Controlled Vocabulary0..1granted
grant_idGrant ID of the associated projectNested Data Structure0..11234567

Properties in 'grant_id'

NameDescriptionData TypeCardinalityExample Value
identifierGrant IDString1776242
typeIdentifier type
Allowed Values:
  • url
  • other
Term from Controlled Vocabulary1other

Properties in 'host'

NameDescriptionData TypeCardinalityExample Value
availabilityAvailabilityString0..199,5
backup__frequencyBackup FrequencyString0..1weekly
backup_typeBackup TypeString0..1tapes
certified_withRepository certified to a recognised standard
Allowed Values:
  • din31644
  • dini-zertifikat
  • dsa
  • iso16363
  • iso16919
  • trac
  • wds
  • coretrustseal
Term from Controlled Vocabulary0..1coretrustseal
descriptionDescriptionString0..1Repository hosted by...
geo_locationPhysical location of the data expressed using ISO 3166-1 country code.Term from Controlled Vocabulary0..1AT
pid_systemPID System
Allowed Values:
  • ark
  • arxiv
  • bibcode
  • doi
  • ean13
  • eissn
  • handle
  • igsn
  • isbn
  • issn
  • istc
  • lissn
  • lsid
  • pmid
  • purl
  • upc
  • url
  • urn
  • other
Term from Controlled Vocabulary0..ndoi
storage_typeThe type of storage requiredString0..1
support_versioning
Allowed Values:
  • yes
  • no
  • unknown
Term from Controlled Vocabulary0..1yes
titleTitleString1Super Repository
urlThe URL of the system hosting a distribution of a datasetURI1https://zenodo.org

Properties in 'license'

NameDescriptionData TypeCardinalityExample Value
license_refLink to license document.URI1https://creativecommons.org/licenses/by/4.0/
start_dateIf date is set in the future, it indicates embargo period. Encoded using the relevant ISO 8601 Date and Time compliant stringDate12019-06-30

Properties in 'metadata'

NameDescriptionData TypeCardinalityExample Value
descriptionDescriptionString0..1provides taxonomy for...
languageLanguage of the metadata expressed using ISO 639-3Term from Controlled Vocabulary1eng
metadata_standard_idMetadata Standard IDNested Data Structure1

Properties in 'metadata_standard_id'

NameDescriptionData TypeCardinalityExample Value
identifierIdentifier for the metadata standard used.String1http://www.dublincore.org/specifications/dublin-core/dcmi-terms/
typeIdentifier type
Allowed Values:
  • url
  • other
Term from Controlled Vocabulary1url

Properties in 'project'

NameDescriptionData TypeCardinalityExample Value
descriptionProject descriptionString0..1Project develops novel...
endProject end date. Encoded using the relevant ISO 8601 Date and Time compliant stringDate0..12020-03-31
fundingFunding related with a projectNested Data Structure0..n
startProject start date. Encoded using the relevant ISO 8601 Date and Time compliant stringDate0..12019-04-01
titleProject titleString1Our New Project

Properties in 'security_and_privacy'

NameDescriptionData TypeCardinalityExample Value
descriptionDescriptionString0..1Server with data must be kept in a locked room
titleTitleString1Physical access control

Properties in 'technical_resource'

NameDescriptionData TypeCardinalityExample Value
descriptionDescription of the technical resourceString0..1Device needed to collect field data...
nameName of the technical resourceString1123/45/43/AT

Cite as

Tomasz Miksa, Paul Walk, Peter Neish. RDA DMP Common Standard for Machine-actionable Data Management Plans. http://doi.org/10.15497/rda00039