the-fair-cookbook

The FAIR cookbook, containing recipes to make your data more FAIR. Find the rendered version on:

https://github.com/fairplus/the-fair-cookbook

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.7%) to scientific vocabulary

Keywords

data fair
Last synced: 6 months ago · JSON representation ·

Repository

The FAIR cookbook, containing recipes to make your data more FAIR. Find the rendered version on:

Basic Info
Statistics
  • Stars: 145
  • Watchers: 11
  • Forks: 61
  • Open Issues: 139
  • Releases: 0
Topics
data fair
Created over 6 years ago · Last pushed 6 months ago
Metadata Files
Readme Citation

README.md

The FAIR Cookbook

Jupyter Book Badge
license build contribute content

FAIR is for Findable, Accessible, Interoperable and Reusable.

This means: - your data and services can be cited - the impact and visibility of your research will be increased - you benefit the public good - your data is more useful because it is easier to compare with other data

This FAIR cookbook gives you step-by-step recipes for making your data FAIR.

For readers

You are probably looking for https://fairplus.github.io/the-fair-cookbook. Or do you want to leave feedback? If so, please see below.

For authors, editors, and developers

More information about the authors of the FAIRPlus Cookbook is available here: Info For Authors

Feedback, support or contact

Having trouble with the page? Want to give feedback?

  • Option 1: Drop us a line at: FAIRplus-cookbook@elixir-europe.org
  • Option 2:file an Issue here on GitHub tracker. Looking forward to hear from you!

Deploy locally:

  • Using Docker:

zsh ./scripts/docker.sh # for MacOS users

or

bash ./scripts/docker.sh # for unix users

  • From outside the project: jupyter-book build -W -n --keep-going the-fair-cookbook

Owner

  • Name: FAIRplus
  • Login: FAIRplus
  • Kind: organization
  • Email: FAIRplus-cookbook@elixir-europe.org

The FAIRplus project develops tools and guidelines for making life science data FAIR (Findable, Accessible, Interoperable, Reusable).

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this resource, please cite it using these metadata.
title: The FAIR Cookbook
abstract: Practical Guidance on how to make data FAIR and move through data maturity
  levels.
authors:
- family-names: Rocca-Serra
  given-names: Philippe
  orcid: https://orcid.org/0000-0001-9853-5668
  affiliation: University of Oxford
- family-names: J G Gray
  given-names: Alasdair
  orcid: https://orcid.org/0000-0002-5711-4872
  affiliation: Heriot Watt University
- family-names: Delfin Rossaro
  given-names: Alejandra
  orcid: https://orcid.org/0000-0002-5423-4203
  affiliation: Universite Paul Sabatier
- family-names: Splendiani
  given-names: Andrea
  orcid: https://orcid.org/0000-0002-3201-9617
  affiliation: Novartis AG
- family-names: Zaliani
  given-names: Andrea
  orcid: https://orcid.org/0000-0002-1740-8390
  affiliation: Fraunhofer Institute
- family-names: Pippow
  given-names: Andreas
  orcid: https://orcid.org/0000-0003-1301-2580
  affiliation: Fraunhofer Institute
- family-names: Cambon-Thomsen
  given-names: Anne
  orcid: https://orcid.org/0000-0001-8793-3644
  affiliation: Universite Paul Sabatier
- family-names: Sedani
  given-names: Ashni
  orcid: https://orcid.org/0000-0002-2424-3483
  affiliation: GSK
- family-names: Goble
  given-names: Carole
  orcid: https://orcid.org/0000-0003-1219-2137
  affiliation: University of Manchester
- family-names: Evelo
  given-names: Chris
  orcid: https://orcid.org/0000-0002-5301-3142
  affiliation: Maastricht University
- family-names: Kee Ong
  given-names: Chuang
  affiliation: Astra-Zeneca
- family-names: Wood
  given-names: Colin
  affiliation: Astra-Zeneca
- family-names: Pommier
  given-names: Cyril
  orcid: https://orcid.org/0000-0002-9040-8733
  affiliation: "Universit\xE9 Paris-Saclay, INRAE, BioinfOmics, Plant bioinformatics\
    \ facility, 78026, Versailles, France"
- family-names: J. B. Clarke
  given-names: Daniel
  orcid: https://orcid.org/0000-0003-3471-7416
  affiliation: Icahn School of Medicine at Mount Sinai
- family-names: Welter
  given-names: Danielle
  orcid: https://orcid.org/0000-0003-1058-2668
  affiliation: University of Luxembourg
- family-names: Henderson
  given-names: David
  orcid: https://orcid.org/0000-0002-6433-200X
  affiliation: Bayer AG
- family-names: Batista
  given-names: Dominique
  orcid: https://orcid.org/0000-0002-2109-489X
  affiliation: University of Oxford
- family-names: Reilly
  given-names: Dorothy
  affiliation: Novartis AG
- family-names: Alharbi
  given-names: Ebtisam
  affiliation: University of Manchester
- family-names: van der Horst
  given-names: Eelke
  orcid: https://orcid.org/0000-0002-8777-5612
  affiliation: The Hyve
- family-names: Willighagen
  given-names: Egon
  orcid: https://orcid.org/0000-0001-7542-0286
  affiliation: Maastricht University
- family-names: Reynares
  given-names: Emiliano
  orcid: https://orcid.org/0000-0002-5109-3716
  affiliation: Boehringer-Ingelheim AG
- family-names: Vos
  given-names: Emma
  orcid: https://orcid.org/0000-0002-8589-0609
  affiliation: The Hyve
- family-names: LeFloch
  given-names: Erwan
  orcid: https://orcid.org/0000-0002-1010-6859
  affiliation: "Universit\xE9 Paris-Saclay, INRAE, BioinfOmics, Plant bioinformatics\
    \ facility, 78026, Versailles, France"
- family-names: Marin del Pico
  given-names: Eva
  orcid: https://orcid.org/0000-0001-8324-2897
  affiliation: Barcelona Supercomputing Centre
- family-names: Ronzano
  given-names: Francesco
  orcid: https://orcid.org/0000-0001-5037-9061
  affiliation: IMIM
- family-names: Kroh
  given-names: Franziska
  affiliation: Fraunhofer Institute
- family-names: Xu
  given-names: Fuqi
  orcid: https://orcid.org/0000-0002-5923-3859
  affiliation: EMBL-EBI
- family-names: Backianathan
  given-names: Gabriel
  affiliation: Novartis AG
- family-names: Papadotas
  given-names: George
  affiliation: GSK
- family-names: Witt
  given-names: Gesa
  orcid: https://orcid.org/0000-0003-2344-706X
  affiliation: Fraunhofer Institute
- family-names: Hurst
  given-names: Hannah
  affiliation: EMBL-EBI
- family-names: Van Vlijmen
  given-names: Herman
  orcid: https://orcid.org/0000-0002-1915-3141
  affiliation: Janssen
- family-names: Emam
  given-names: Ibrahim
  orcid: https://orcid.org/0000-0002-7561-2787
  affiliation: Imperial College London
- family-names: Liyanage
  given-names: Isuru
  orcid: https://orcid.org/0000-0002-4839-5158
  affiliation: EMBL-EBI
- family-names: Neefs
  given-names: Jean-Marc
  affiliation: Janssen
- family-names: Strubel
  given-names: Jolanda
  orcid: https://orcid.org/0000-0001-6675-4639
  affiliation: The Hyve
- family-names: Quast
  given-names: Karsten
  affiliation: Boehringer-Ingelheim AG
- family-names: van Bochove
  given-names: Kees
  orcid: https://orcid.org/0000-0002-8589-0609
  affiliation: The Hyve
- family-names: Dauth
  given-names: Kurt
  affiliation: Boehringer-Ingelheim AG
- family-names: Furlong
  given-names: Laura
  orcid: https://orcid.org/0000-0002-9383-528X
  affiliation: IMIM
- family-names: Garcia
  given-names: Leyla
  orcid: https://orcid.org/0000-0003-3986-0510
  affiliation: ZB MED Information Centre for life sciences
- family-names: Giovanni
  given-names: Lucas
  orcid: https://orcid.org/0000-0001-6518-9535
  affiliation: Maastricht University
- family-names: Kohler
  given-names: Manfred
  affiliation: Fraunhofer Institute
- family-names: Pruess
  given-names: Manuela
  orcid: https://orcid.org/0000-0002-6857-5543
  affiliation: SIB
- family-names: Ibberson
  given-names: Mark
  orcid: https://orcid.org/0000-0003-3152-5670
  affiliation: SIB
- family-names: Cook
  given-names: Martin
  affiliation: Elixir Europe
- family-names: Courtot
  given-names: Melanie
  orcid: https://orcid.org/0000-0002-9551-6370
  affiliation: EMBL-EBI
- family-names: d'Arcy
  given-names: Mike
  orcid: https://orcid.org/0000-0003-2280-917X
  affiliation: University of Southern California
- family-names: Juty
  given-names: Nick
  orcid: https://orcid.org/0000-0002-2036-8350
  affiliation: University of Manchester
- family-names: Lynch
  given-names: Nick
  orcid: https://orcid.org/0000-0002-8997-5298
  affiliation: OpenPhacts
- family-names: Engkvist
  given-names: Ola
  orcid: https://orcid.org/0000-0003-4970-6461
  affiliation: Astra-Zeneca
- family-names: Deniz Beyan
  given-names: Oya
  orcid: https://orcid.org/0000-0001-7611-3501
  affiliation: Fraunhofer Institute
- family-names: Peeters
  given-names: Paul
  orcid: https://orcid.org/0000-0001-9915-2933
  affiliation: Janssen
- family-names: Woollard
  given-names: Peter
  orcid: https://orcid.org/0000-0002-7654-6902
  affiliation: GSK
- family-names: Papadopoulos
  given-names: Petros
  orcid: https://orcid.org/0000-0002-8110-7576
  affiliation: Heriot Watt University
- family-names: Gribbon
  given-names: Philip
  orcid: https://orcid.org/0000-0001-7655-2459
  affiliation: Fraunhofer Institute
- family-names: Sahay
  given-names: Ratnesh
  affiliation: Astra-Zeneca
- family-names: Giessmann
  given-names: Robert
  orcid: https://orcid.org/0000-0002-0254-1500
  affiliation: Bayer AG
- family-names: Verbeeck
  given-names: Rudi
  orcid: https://orcid.org/0000-0001-5445-6095
  affiliation: Janssen
- family-names: Capella Gutierrez
  given-names: Salvador
  orcid: https://orcid.org/0000-0002-0309-604X
  affiliation: Barcelona Supercomputing Centre
- family-names: Lusher
  given-names: Scott
  affiliation: Janssen
- family-names: Beier
  given-names: Sebastian
  orcid: https://orcid.org/0000-0002-2177-8781
  affiliation: Bioinformatics and Information Technology Group, Leibniz Institute
    of Plant Genetics and Crop Plant Research (IPK), 06466 Seeland, Germany
- family-names: Singh
  given-names: Sukhi
  orcid: https://orcid.org/0000-0001-8324-2897
  affiliation: The Hyve
- family-names: Sansone
  given-names: Susanna-Assunta
  orcid: https://orcid.org/0000-0001-5306-5690
  affiliation: University of Oxford
- family-names: Plasterer
  given-names: Tom
  affiliation: Astra-Zeneca
- family-names: Burdett
  given-names: Tony
  orcid: https://orcid.org/0000-0002-2513-5396
  affiliation: EMBL-EBI
- family-names: Abbassi-Daloii
  given-names: Tooba
  orcid: https://orcid.org/0000-0002-4904-3269
  affiliation: Maastricht University
- family-names: Goldmann
  given-names: Ulrich
  orcid: https://orcid.org/0000-0003-1120-6912
  affiliation: CEMM
- family-names: "Grou\xE8s"
  given-names: Valentin
  orcid: https://orcid.org/0000-0001-6501-0806
  affiliation: University of Luxembourg
- family-names: Ioannidis
  given-names: Vassilios
  orcid: https://orcid.org/0000-0002-4209-2578
  affiliation: SIB
- family-names: P. Satagopam
  given-names: Venkata
  orcid: https://orcid.org/0000-0002-6532-5880
  affiliation: University of Luxembourg
- family-names: Sedlyarov
  given-names: Vitaly
  orcid: https://orcid.org/0000-0002-9872-3535
  affiliation: Boehringer-Ingelheim AG
- family-names: Gu
  given-names: Wei
  orcid: https://orcid.org/0000-0003-3951-6680
  affiliation: University of Luxembourg
- family-names: Gaidya
  given-names: Yojana
  orcid: https://orcid.org/0000-0002-7683-0452
  affiliation: Fraunhofer Institute
- family-names: Warnes
  given-names: Zachary
  orcid: https://orcid.org/0000-0002-7777-6013
  affiliation: Maastricht University
version: 0.1.0
date-released: '2022-04-30'
identifiers:
- type: doi
  value: 10.0000.1234/ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._[]()\:;
  description: A pseudo-DOI testing all allowed characters.
license: CC-BY-4.0
license-url: https://creativecommons.org/licenses/by/4.0/
repository-code: https://github.com/FAIRplus/the-fair-cookbook/
url: https://faircookbook.elixir-europe.org/content/home.html

GitHub Events

Total
  • Issues event: 12
  • Watch event: 17
  • Delete event: 4
  • Issue comment event: 18
  • Push event: 38
  • Pull request event: 19
  • Fork event: 5
  • Create event: 8
Last Year
  • Issues event: 12
  • Watch event: 17
  • Delete event: 4
  • Issue comment event: 18
  • Push event: 38
  • Pull request event: 19
  • Fork event: 5
  • Create event: 8

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 104
  • Total pull requests: 94
  • Average time to close issues: 7 months
  • Average time to close pull requests: 28 days
  • Total issue authors: 26
  • Total pull request authors: 27
  • Average comments per issue: 2.71
  • Average comments per pull request: 1.15
  • Merged pull requests: 59
  • Bot issues: 0
  • Bot pull requests: 9
Past Year
  • Issues: 1
  • Pull requests: 11
  • Average time to close issues: N/A
  • Average time to close pull requests: about 2 months
  • Issue authors: 1
  • Pull request authors: 6
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.64
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 4
Top Authors
Issue Authors
  • proccaserra (34)
  • ghost (21)
  • FuqiX (9)
  • JolandaS (7)
  • egonw (5)
  • AlasdairGray (5)
  • vioannid (4)
  • daniwelter (3)
  • erlefloch (2)
  • ljgarcia (2)
  • bedroesb (1)
  • gabrielmacedoanac (1)
  • robertmand (1)
  • vildead (1)
  • rabuono (1)
Pull Request Authors
  • proccaserra (24)
  • vioannid (14)
  • dependabot[bot] (9)
  • egonw (5)
  • ghost (4)
  • tabbassidaloii (4)
  • terazus (4)
  • ulo (3)
  • ramGranell (3)
  • AlasdairGray (3)
  • erlefloch (3)
  • daniwelter (2)
  • FuqiX (2)
  • cthoyt (2)
  • LiubovShilova (2)
Top Labels
Issue Labels
issue type: meta checklist (15) closed because: done (15) issue type: proposal - cookbook backend (11) author's task: write abstract (10) issue type: proposal - cookbook general content (9) UC30 (9) issue type: proposal - cookbook documentation (8) stale? (8) issue type: author's tracker (7) UC27 (7) priorization: long-term goal / not time-critical (6) author's task: write recipe (6) editor's task: identify author (4) issue type: proposal - new recipe (4) closed because: done partially (3) reviewer's task: submit review (3) issue type: bug (3) issue type: proposal (3) closed because: duplicate (3) closed because: low priority -> moved into backlog (3) issue type: proposal - recipe change requested (2) UC9 (2) close because: priority -10 -> no work on it (2) editor's task: hand recipe to review (2) editor's task: give feedback on abstract (1) editor's task: manage unsolicited submission (1) IMIDIA/RHAPSODY (1) UC4 (1) Interoperability (1) author's task: incorporate review comments (1)
Pull Request Labels
dependencies (8) python (8) editor's task: assess review&initialize next steps (2) issue type: proposal - cookbook documentation (2) issue type: bug (1) issue type: proposal - cookbook backend (1) editor's task: hand recipe to review (1) reviewer's task: submit review (1)

Dependencies

.github/workflows/build-migrating.yml actions
  • JamesIves/github-pages-deploy-action releases/v3 composite
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • webfactory/ssh-agent v0.4.1 composite
.github/workflows/record_repo_traffic.yml actions
  • EndBug/add-and-commit v4 composite
  • actions/checkout v2 composite
  • sangonzal/repository-traffic-action v0.1.5 composite
Dockerfile docker
  • alpine latest build
  • jupyterbookbuilder-base-image latest build
  • minlag/mermaid-cli 8.13.4 build
  • python 3.7.8-slim-buster build
requirements.txt pypi
  • Babel ==2.9.1
  • GitPython ==3.1.14
  • Jinja2 ==2.11.3
  • MarkupSafe ==1.1.1
  • PyYAML ==5.4.1
  • Pygments ==2.8.1
  • SQLAlchemy ==1.3.24
  • Send2Trash >=1.8.0
  • Sphinx ==3.5.4
  • alabaster ==0.7.12
  • anyio ==3.1.0
  • argon2-cffi ==20.1.0
  • async-generator ==1.10
  • attrs ==20.3.0
  • backcall ==0.2.0
  • beautifulsoup4 ==4.9.3
  • bleach ==3.3.0
  • certifi ==2020.12.5
  • cffi ==1.14.5
  • chardet ==4.0.0
  • click ==7.1.2
  • colorama ==0.4.4
  • decorator ==5.0.7
  • defusedxml ==0.7.1
  • deprecation ==2.1.0
  • docutils ==0.16
  • entrypoints ==0.3
  • gitdb ==4.0.7
  • idna ==2.10
  • imagesize ==1.2.0
  • importlib-metadata ==4.0.1
  • ipykernel ==5.5.3
  • ipython ==7.31.1
  • ipython-genutils ==0.2.0
  • ipywidgets ==7.6.3
  • jedi ==0.18.0
  • jsonschema ==3.2.0
  • jupyter-book ==0.10.2
  • jupyter-cache ==0.4.2
  • jupyter-client ==6.1.12
  • jupyter-core ==4.7.1
  • jupyter-packaging ==0.9.2
  • jupyter-server ==1.15.4
  • jupyter-server-mathjax ==0.2.2
  • jupyter-sphinx ==0.3.1
  • jupyterbook-latex ==0.2.0
  • jupyterlab-widgets ==1.0.0
  • jupytext ==1.10.3
  • latexcodec ==2.0.1
  • linkify-it-py ==1.0.1
  • markdown-it-py ==0.6.2
  • mdit-py-plugins ==0.2.6
  • mistune ==0.8.4
  • myst-nb ==0.12.0
  • myst-parser ==0.13.6
  • nbclient ==0.5.3
  • nbconvert ==5.6.1
  • nbdime ==3.1.1
  • nbformat ==5.2.0
  • nest-asyncio ==1.5.1
  • nested-lookup ==0.2.22
  • notebook >=6.4.12
  • packaging ==20.9
  • pandocfilters ==1.4.3
  • parso ==0.8.2
  • pexpect ==4.8.0
  • pickleshare ==0.7.5
  • prometheus-client ==0.10.1
  • prompt-toolkit ==3.0.18
  • ptyprocess ==0.7.0
  • pybtex ==0.24.0
  • pybtex-docutils ==1.0.0
  • pycparser ==2.20
  • pydata-sphinx-theme ==0.4.3
  • pyparsing ==2.4.7
  • pyrsistent ==0.17.3
  • python-dateutil ==2.8.1
  • pytz ==2021.1
  • pyzmq ==22.0.3
  • requests ==2.25.1
  • six ==1.15.0
  • smmap ==4.0.0
  • sniffio ==1.2.0
  • snowballstemmer ==2.1.0
  • soupsieve ==2.2.1
  • sphinx-book-theme ==0.0.42
  • sphinx-comments ==0.0.3
  • sphinx-copybutton ==0.3.1
  • sphinx-panels ==0.5.2
  • sphinx-sitemap ==2.2.0
  • sphinx-thebe ==0.0.8
  • sphinx-togglebutton ==0.2.3
  • sphinxcontrib-applehelp ==1.0.2
  • sphinxcontrib-bibtex ==2.1.0
  • sphinxcontrib-devhelp ==1.0.2
  • sphinxcontrib-htmlhelp ==1.0.3
  • sphinxcontrib-jsmath ==1.0.1
  • sphinxcontrib-qthelp ==1.0.3
  • sphinxcontrib-serializinghtml ==1.1.4
  • sphinxcontrib-youtube ==1.2.0
  • terminado ==0.9.4
  • testpath ==0.4.4
  • toml ==0.10.2
  • tomlkit ==0.7.0
  • tornado ==6.1
  • traitlets ==5.0.5
  • uc-micro-py ==1.0.1
  • urllib3 ==1.26.5
  • wcwidth ==0.2.5
  • webencodings ==0.5.1
  • widgetsnbextension ==3.5.1
  • zipp ==3.4.1