JSON-LD Enabled Automated Assessments

FAIRshake can take advantage of schema.org JSON-LD metadata available on some websites to help perform automated assessments. This information doesn't just help FAIRshake, it also enables other applications such as Google Dataset Search and BioThings and is part of the reason exposing it is an important part of making your digital objects FAIR.

The additional metadata can be placed on your digital objects hosting webpages, especially on the landing pages of resources.

<html>
<head>
...
<script type="application/ld+json">
your_json_schema_goes_here
</script>
...
</head>
...
</html>

The json exposes the information on the page in a way that a machine can read and interpret it. The information required is largely based on what it is. A dataset landing page might look like this:

<html>
<head>
...
<script type="application/ld+json">
{
  "@context": "http://schema.org",
  "@type": "Dataset",
  "name": "The name of the item",
  "description": "A description of the item",
  "url": "URL of the item",
  "keywords": "Keywords or tags used to describe this item",
  "includedInDataCatalog": "URL of the containing DataCatalog",
  "creator": {
    "@type": "Organization",
    "name": "Organization name"
  },
  "version": "Version Number",
  "license": "License names"
}
</script>
...
</head>
</html>

Validation

One way to confirm that your schema is working and will be properly recognized is by using Google's structured data testing tool. This tool can also take JSON-LD directly allowing you to check for errors before deploying it on your website.

More Examples

General

Google's Developer Guides provide the most comprehensive resource currently available describing and providing examples of this data.

  • WebSite example
    {
  "@context": "http://schema.org",
  "@type": "WebSite",
  "url": "http://amp.pharm.mssm.edu/Harmonizome/",
  "potentialAction": [
    {
      "@type": "SearchAction",
      "target": "http://amp.pharm.mssm.edu/Harmonizome/search?t=all&q={query}",
      "query-input": "required name=query"
    }
  ]
}

Biology

Bioschemas.org has put together many examples of JSON-LD for different biological entities. I've selected a few from their repository and linked them here.