FAIRshake User Guide V.2

CFDE CC MOD 16 Workplan 2021 Deliverable 5.c

Submitted: April 30, 2022

Authors: Daniel J.B. Clarke, MS; Eryk Kropiwnicki, MS; Avi Ma’ayan, PhD





















Table of Contents


I.        What is FAIRshake?


II.        Getting Started


-         Starting a FAIRshake project

-         Associating digital objects with a FAIRshake project

-         Associating a rubric with a digital object registered in FAIRshake

-         Performing your first assessment with FAIRshake


III.        Metrics and Rubrics


-        What is a FAIRshake metric?

-         What is a FAIRshake rubric?

-         Creating a new metric in FAIRshake

-         Adding the new metric to an existing rubric

-         Creating a new rubric in FAIRshake


IV.        Visualizing and Evaluating FAIRshake Results


-         The FAIRshake insignia

-         FAIRshake analytics


V.        Advanced Topics


-        Automated FAIR assessments with FAIRshake

-         Creating an automated assessment with FAIRshake

-         Embedding the FAIRshake insignia in my website


VI.      References

I.            What is FAIRshake?

As more digital resources are produced by the research community, it is becoming increasingly important to harmonize and organize them for synergistic utilization and reuse. The findable, accessible, interoperable, and reusable (FAIR) guiding principles [1] have prompted many stakeholders to consider strategies for tackling this challenge. The FAIRshake toolkit [2] was developed to enable the establishment of community-driven FAIR metrics and rubrics paired with manual and automated FAIR assessments. FAIR assessments are visualized as an insignia that can be embedded within digital-resources-hosting websites. Using FAIRshake, a variety of biomedical digital resources can be manually and automatically evaluated for their level of FAIRness. The purpose of FAIRshake is not to penalize and judge digital object producers and servers, but to assist them with improving the interoperability of the products they produce and host. FAIRshake was also created to promote the use of community standards so an ecosystem of digital objects can better interoperate.


II.          Getting Started


Starting a Project with FAIRshake

FAIRshake can be accessed from https://fairshake.cloud. On the site, the Projects tab lists existing FAIRshake projects. Each project in FAIRshake bundles a collection of registered digital objects that are associated with the project. Examples of such digital objects include software tools, datasets, databases, API, or workflows. Each of these digital objects is associated with one or more FAIR rubrics used to evaluate it. To start your own project in FAIRsahke, you need to first establish a user account (Fig. 1) and sign in (Fig. 2). FAIRshake support account set up and sign in with ORCID, GitHub, or Globus. Accounts in these environments are not required. The user can sign up with their own username and e-mail exclusively with FAIRshake.

Fig. 1 FAIRshake sign up page



Fig. 2 FAIRshake sign in page


Next, on the Projects page, click the “Create New Project” card. This will invoke the presentation of an input form for submitting metadata about the project. Once you are done filling out the form, press submit to establish the project in the FAIRshake database (Fig. 3).


Fig. 3 Operations for creating a new project


Associating digital objects with a project in FAIRshake

Navigate to your project’s page. Under the “Associated Digital Objects” header, click the “Create New Digital Object” card. You will be presented with an input form for entering metadata about your digital object (Fig. 4).


Fig 4. Associating a new digital object with a project


In the rubrics autocomplete field, enter text to search for available rubrics. You will be presented with a list of potentially relevant rubrics that you might want to be associated with your digital object. Once the form is submitted, you will be redirected to a page that is created specifically for your digital object with the associated projects and rubrics (Fig. 5).

Fig 5. Digital object page


Associating a rubric with a digital object in FAIRshake


A rubric is a set of questions used to evaluate the FAIRness of a specific digital object in a particular project. To create a rubric, navigate to the “Rubrics” tab in the navigation bar. Click the “Create New Rubric” card to start. You will see an input form where you can enter information about your rubric (Fig. 6).

Fig 6. Input form options for creating a new rubric.


The “Metrics” field within the form is an autocomplete text search that provide options to select from existing metrics already inside the FAIRshake database. Once starting to type, previously defined metrics that may be added to the rubric are listed (Fig. 7).