Write a schema

Table of Contents

  1. Using the Semantic Engine
  2. Use a Schema
    1. Create a Data Entry Excel
    2. Verify data in a web browser
    3. Save your data together with your schema
    4. Contributing to the schema library

All datasets have a schema, either implicit or explicit. The goal of the Semantic Engine is to take your knowledge of the data and document that explicitly using a schema.

To easily write machine-readable schemas in the OCA schema language, the organization Agri-food Data Canada (ADC) from the University of Guelph has developed a friendly user-interface for documenting data and using the schemas that have been generated.

Using the Semantic Engine

The Semantic Engine has been developed to be a self-directed site for researchers to document any table-based research data. Throughout the site there is helpful documentation as well as a tutorial webpage.

Use a Schema

Create a Data Entry Excel

On the Semantic Engine website you can use the machine-readable version of your schema to generate a Excel sheet that has been prefilled according to the rules of the schema and ready for data entry. Data Entry Excel

When you open your Data Entry Excel you will see it consists of two sheets, one for schema description and one for the entry for data. The schema description sheets takes information from the schema that was uploaded and puts it into an information table.

Verify data in a web browser

You can use your schema to enter and verify data using your web browser.

Data verification

The Data Entry Web tool of the Semantic Engine lets you upload your schema and then you can optionally upload a dataset. If you choose to upload a dataset, remember the Semantic Engine tool never receive your data. Instead, your data is ‘uploaded’ into your browser and all the data processing happens locally.

If you don’t want to upload a dataset, you can skip this step and go right to the end where you can enter and verify your data in the web browser. You add rows of blank data using the ‘Add rows’ button at the bottom and then enter the data. You can hover over the ?’s to see what data is expected, or click on the ‘verification rules’ to see the schema again to help you enter your data.

Save your data together with your schema

Store your schema multiple ways.

  1. Store a schema with your dataset and share it when you share your data.
  2. Share a schema with your lab or collaborators by storing it in a shared lab drive.
  3. Store your schema as an independent object in a repository such as Borealis or Zenodo.

Store the machine-readable schema bundle version and the .txt human-readable version together for best usability.

Contributing to the schema library

The Data Hub project of Genome Canada is creating a schema library as part of its mandate to help with data harmonization and the creation of data standards across project members.

After creating your data schema using the Semantic Engine you can upload your machine-readable schema bundle and generate the markdown readme. First add catalogue information so your name, email, and ICT group are added to the schema and so that your schema is sorted correctly in the library. Then generate your markdown readme and add it to the schema library in the schema folder.

Catalogue metadata and schema in markdown

  • written by Carly Huitema