Update metadata format to accommodate more FAIR principles

[ThierryO]

FAIR stands for Findable, Accessible, Interoperable and Resuable.

This checklist lists following items. I tried to asses the current status of git2rdata. Which items should we handle first when improving git2rdata?

How can I ask feedback from the ropensci community? @noamross @maelle

Current status in git2rdata

:white_check_mark: not relevant :x: missing :ballot_box_with_check: partially implemented :heavy_check_mark: fully implemented

Findable

It should be possible for others to discover your data. Rich metadata should be available online in a searchable resource, and the data should be assigned a persistent identifier.

:white_check_mark: A persistent identifier is assigned to your data :ballot_box_with_check: There are rich metadata, describing your data :white_check_mark: The metadata are online in a searchable resource e.g. a catalogue or data repository :x: The metadata record specifies the persistent identifier

Accessible

It should be possible for humans and machines to gain access to your data, under specific conditions or restrictions where appropriate. FAIR does not mean that data need to be open!

:white_check_mark: Following the persistent ID will take you to the data or associated metadata :white_check_mark: The protocol by which data can be retrieved follows recognised standards e.g. http :white_check_mark: The access procedure includes authentication and authorisation steps, if necessary :white_check_mark: Metadata are accessible, wherever possible, even if the data aren’t

Interoperable

Data, metadata should conform to recognised formats and standards to allow them to be combined and exchanged.

:heavy_check_mark: Data is provided in commonly understood and preferably open formats :ballot_box_with_check: The metadata provided follows relevant standards :x: Controlled vocabularies, keywords, thesauri or ontologies are used where possible :x: Qualified references and links are provided to other related data

Reusable

Documentation is needed to support data interpretation and reuse. The data should conform to community norms and be clearly licensed so others know what kinds of reuse are permitted.

:ballot_box_with_check: The data are accurate and are well described with many relevant attributes :x: The data have a clear and accessible data usage license :x: It is clear how, why, when and by whom the data have been created and processed :white_check_mark: The data and metadata meet relevant domain standards

[ElsLommelen]

To guide users to the FAIR principle, make sure to include a vignette that also covers the 'not relevant' categories to learn users how to implement it.

[maelle]

@ThierryO In the slack?

Also, I could include a brief text where you'd explain what your questions are, for inclusion in the newsletter.