TrainingMaterial DRAFT Profile

The Life Science Training Materials specification provides a way to describe bioscience training material on the World Wide Web. It defines a set of metadata and vocabularies, built on top of existing technologies and standards, that can be used to represent events in Web pages and applications. The goal of the specification is to make it easier to discover, exchange and integrate life science training material information across the Internet.

Latest profiles

Latest release: none

Latest draft: 0.8-DRAFT-2020_10_06

Previous profiles

Previous version: 0.6-DRAFT-2019_06_06

Group	Use Cases	Cross Walk	Task & Issues	Examples	Live Deploys
Training

You can read the release version of this specification here.

Key to specification table

Schema.org properties where the Expected Types have been changed, or new (i.e., Bioschemas created) properties/types are green.

Schema.org properties/types are red.

Pending Schema.org properties/types are blue.

External (i.e., from 3rd party ontology) properties/types are black.

CD = Cardinality

View all examples

//Property: about
"about": [{
  "@type": "DefinedTerm", 
  "@id": "http://edamontology.org/topic_3316",
  "inDefinedTermSet": "http://edamontology.org",
  "termCode": "topic_3316",
  "name": "Computer Science",
  "url": "https://bioportal.bioontology.org/ontologies/EDAM/?p=classes&conceptid=http%3A%2F%2Fedamontology.org%2Ftopic_3316"
}, {
   "@id": "https://zenodo.org/record/1480624#.W-2as3r0nCM"
}]


//Property: abstract
"abstract": "This tutorial will take you through the basic usage of the command line shell. In it, you will discover what a shell is, skills for directory navigation, file manipulation, and how to run tools"



//Property: accessibilitySummary
"accessibilitySummary": "Visual elements are not described."



//Property: audience
"audience": {
  "@type": "Audience",
  "audienceType": "PhD students" 
}


//Property: author
"author":  [{
  "@type": "Person",
  "name": "Elizabeth Windsor",
  "email": "e.r.windsor@gmail.com"
},{ 
  "@type": "Organization",
  "name": "University of Manchester"
}]


//Property: contributor
"contributor":  [{
  "@type": "Person",
  "name": "Bob Smith",
},{ 
  "@type": "Organization",
  "name": "University of Edinburgh"
}]


//Property: dateCreated
"dateCreated": "2018-07-04T11:24:13+00:00"


//Property: dateModified
"dateModified": "2018-08-04T19:34:12+00:00"


//Property: datePublished
"datePublished": "2018-08-04T19:34:12+00:00"


//Property: description
"description": "This tutorial will take you through the basic usage of the command line shell. In it, you will discover what a shell is, skills for directory navigation, file manipulation, and how to run tools. To complete this training material you will need to have a shell (linux), powershell (windows), or terminal (mac) ready. You do not need any previous experience to complete the tasks"



//Property: featuredInEvent
"featuredIn": [{
"@type": "CourseInstance",
"name": "CS101 Summer 2009",
"url": "http://101.cs.org"
}]


//Property: hasPart
"hasPart": [
{
    "@type": "CreativeWork",
    "url": "http://directoryVisuals.io",
    "name": "Shell Directory Visualizer"
 }, 
 {
    "@type": "CreativeWork",
    "url": "http://shell.io",
    "name": "Interactive Shell tutorial"
}]


//Property: identifier
"identifier": [
  "http://identifiers.org/my-org/13412",
  "http://dx.doi.org/12349302"
]


//Property: inLanguage
"inLanguage": ["en-US", "fr-FR"]


//Property: isPartOf
"isPartOf": [{
      "@type": "CreativeWork",
      "url": "http://computerScience4LS.org",
      "name": "The complete Computer Science for Life Scientists Coursebook"
}]


//Property: keywords
"keywords": "Unix, Shell, Command Line Tools, Terminal, Bash"


//Property: learningOutcome
"learningOutcome": ["The student will be able to recall shell commands", "The student will be able to write code to copy files", "The student will be able to discover new commands on their own"]



//Property: learningResourceType
"learningResourceType": ["handout"]


//Property: license
"license": ["https://creativecommons.org/licenses/by/4.0/"]


//Property: mentions
"mentions": [{
  "@type": "Tool",
  "name": "Galaxy",
  "url": "https://bio.tools/galaxy",
  "description": "Open, web-based platform for data intensive biomedical research"
},{
  "@type": "Dataset",
  "name": "European Genome-phenome Archive",
  "url": "https://www.ebi.ac.uk/ega/home",
  "description": "The EGA archives a large number of datasets, the access to which is controlled by a Data Access Committee (DAC)."
}]


//Property: name
"name": "The Unix Command Line tutorial for Bioinformaticians"


//Property: skillLevel
"skillLevel": "beginner"


//Property: status
"status": "active"


//Property: timeRequired
"timeRequired": "P1W2DT5H"


//Property: translatedInto
"translatedInto": [
"fr-FR"
]


//Property: url
"url": "http://teach-me-ctl.com/tutorial"


//Property: uses
"uses": [{
  "@type": "Tool",
  "name": "Galaxy",
  "url": "https://bio.tools/galaxy",
  "description": "Open, web-based platform for data intensive biomedical research"
},{
  "@type": "Dataset",
  "name": "European Genome-phenome Archive",
  "url": "https://www.ebi.ac.uk/ega/home",
  "description": "The EGA archives a large number of datasets, the access to which is controlled by a Data Access Committee (DAC)."
}]


//Property: version
"version": "0.2.0"

Property	Expected Type	Description	CD	Controlled Vocabulary	Example
Marginality: Minimum.
description	Text	Schema: A description of the item.	ONE		View ≪description≫ example Property ≪description≫ example `"description": "This tutorial will take you through the basic usage of the command line shell. In it, you will discover what a shell is, skills for directory navigation, file manipulation, and how to run tools. To complete this training material you will need to have a shell (linux), powershell (windows), or terminal (mac) ready. You do not need any previous experience to complete the tasks"`
keywords	Text	Schema: Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.	ONE		View ≪keywords≫ example Property ≪keywords≫ example `"keywords": "Unix, Shell, Command Line Tools, Terminal, Bash"`
name	Text	Schema: The name of the item.	ONE		View ≪name≫ example Property ≪name≫ example `"name": "The Unix Command Line tutorial for Bioinformaticians"`
Marginality: Recommended.
about	Thing	Schema: The subject matter of the content. Bioschemas: The subject of this Training Material. Use the DefinedTerm type to add a controlled vocabulary term to describe the topic (such as from the EDAM ontology)	MANY	EDAM Topic Ontology	View ≪about≫ example Property ≪about≫ example `"about": [{ "@type": "DefinedTerm", "@id": "http://edamontology.org/topic_3316", "inDefinedTermSet": "http://edamontology.org", "termCode": "topic_3316", "name": "Computer Science", "url": "https://bioportal.bioontology.org/ontologies/EDAM/?p=classes&conceptid=http%3A%2F%2Fedamontology.org%2Ftopic_3316" }, { "@id": "https://zenodo.org/record/1480624#.W-2as3r0nCM" }]`
abstract	Text	Schema: A brief overview of the item.	ONE		View ≪abstract≫ example Property ≪abstract≫ example `"abstract": "This tutorial will take you through the basic usage of the command line shell. In it, you will discover what a shell is, skills for directory navigation, file manipulation, and how to run tools"`
audience	Audience	Schema: An intended audience, i.e. a group for whom something was created. Supersedes serviceAudience. Bioschemas: A succinct description of the intended target audience for your materials: e.g., graduates, postgraduates, clinicians.	MANY		View ≪audience≫ example Property ≪audience≫ example `"audience": { "@type": "Audience", "audienceType": "PhD students" }`
author	Organization Person	Schema: The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. Bioschemas: Those involved in the preparation, creation and/or presentation of the published work, specifically creating the original version.	MANY		View ≪author≫ example Property ≪author≫ example `"author": [{ "@type": "Person", "name": "Elizabeth Windsor", "email": "e.r.windsor@gmail.com" },{ "@type": "Organization", "name": "University of Manchester" }]`
identifier	PropertyValue Text URL	Schema: The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details. Bioschemas: An identifier for this Training Material, such as a DOI or compact URI	MANY		View ≪identifier≫ example Property ≪identifier≫ example `"identifier": [ "http://identifiers.org/my-org/13412", "http://dx.doi.org/12349302" ]`
inLanguage	Language Text	Schema: The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also availableLanguage. Supersedes language. Bioschemas: Defaults to English if not specified. Please choose a value from IETF BCP 47 standard. You can add multiple languages if the Training Material offers different translations	MANY	IETF BCP 47 standard	View ≪inLanguage≫ example Property ≪inLanguage≫ example `"inLanguage": ["en-US", "fr-FR"]`
learningOutcome	Text	Schema: Statements that describe what knowledge, skills or abilities students should acquire on completion of this Training Material	MANY	It is recommended that you utilize terms from Blooms taxonomy	View ≪learningOutcome≫ example Property ≪learningOutcome≫ example `"learningOutcome": ["The student will be able to recall shell commands", "The student will be able to write code to copy files", "The student will be able to discover new commands on their own"]`
learningResourceType	Text	Schema: The predominant type or kind characterizing the learning resource. For example, ‘presentation’, ‘handout’. Bioschemas: This may also include things such as video lecture, e-Learning module, or tutorial.	MANY		View ≪learningResourceType≫ example Property ≪learningResourceType≫ example `"learningResourceType": ["handout"]`
license	CreativeWork URL	Schema: A license document that applies to this content, typically indicated by URL. Bioschemas: If there is a licence it must be added.	MANY		View ≪license≫ example Property ≪license≫ example `"license": ["https://creativecommons.org/licenses/by/4.0/"]`
mentions	Thing	Schema: Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. Bioschemas: Data-sets, tools, technologies, entities, other training materials in the series, etc., to which this Training Material makes reference. See ‘uses’ for resources that are actively utilised in this training material.	MANY		View ≪mentions≫ example Property ≪mentions≫ example `"mentions": [{ "@type": "Tool", "name": "Galaxy", "url": "https://bio.tools/galaxy", "description": "Open, web-based platform for data intensive biomedical research" },{ "@type": "Dataset", "name": "European Genome-phenome Archive", "url": "https://www.ebi.ac.uk/ega/home", "description": "The EGA archives a large number of datasets, the access to which is controlled by a Data Access Committee (DAC)." }]`
skillLevel	Text	Schema: The target skill level in the topic being taught. Examples of skill levels include ‘beginner’, ‘intermediate’ or ‘advanced’.	ONE	Beginner Intermediate Advanced	View ≪skillLevel≫ example Property ≪skillLevel≫ example `"skillLevel": "beginner"`
timeRequired	Duration	Schema: Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. ‘P30M’, ‘P1H25M’. Bioschemas: Please specify in ISO 8601 duration format.	ONE	ISO 8601 duration format.	View ≪timeRequired≫ example Property ≪timeRequired≫ example `"timeRequired": "P1W2DT5H"`
url	URL	Schema: URL of the item. Bioschemas: The preferred URL of the Training Material. You must provide this value if it is known.	ONE		View ≪url≫ example Property ≪url≫ example `"url": "http://teach-me-ctl.com/tutorial"`
uses	Thing	Schema: Lists datasets, tools, technologies, or other entities used. Bioschemas: Data-sets, tools, technologies, entities, etc. that are actively utilised in this Training Material.	MANY		View ≪uses≫ example Property ≪uses≫ example `"uses": [{ "@type": "Tool", "name": "Galaxy", "url": "https://bio.tools/galaxy", "description": "Open, web-based platform for data intensive biomedical research" },{ "@type": "Dataset", "name": "European Genome-phenome Archive", "url": "https://www.ebi.ac.uk/ega/home", "description": "The EGA archives a large number of datasets, the access to which is controlled by a Data Access Committee (DAC)." }]`
Marginality: Optional.
accessibilitySummary	Text	Schema: A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as “short descriptions are present but long descriptions will be needed for non-visual users” or “short descriptions are present and no long descriptions are needed.”	ONE		View ≪accessibilitySummary≫ example Property ≪accessibilitySummary≫ example `"accessibilitySummary": "Visual elements are not described."`
contributor	Organization Person	Schema: A secondary contributor to the CreativeWork or Event. Bioschemas: Contributors are those who made non-authorship contributions: e.g., critical review, commentary or revision.	MANY		View ≪contributor≫ example Property ≪contributor≫ example `"contributor": [{ "@type": "Person", "name": "Bob Smith", },{ "@type": "Organization", "name": "University of Edinburgh" }]`
dateCreated	Date DateTime	Schema: The date on which the CreativeWork was created or the item was added to a DataFeed.	ONE		View ≪dateCreated≫ example Property ≪dateCreated≫ example `"dateCreated": "2018-07-04T11:24:13+00:00"`
dateModified	Date DateTime	Schema: The date on which the CreativeWork was most recently modified or when the item’s entry was modified within a DataFeed.	ONE		View ≪dateModified≫ example Property ≪dateModified≫ example `"dateModified": "2018-08-04T19:34:12+00:00"`
datePublished	Date	Schema: Date of first broadcast/publication.	ONE		View ≪datePublished≫ example Property ≪datePublished≫ example `"datePublished": "2018-08-04T19:34:12+00:00"`
featuredInEvent	Event Course	Schema: The course instance or event where this training material was or will be featured. Inverse of workFeatured. Bioschemas: Use isPartOf to refer to a Course, unless this Training Material is unique to a specific Course Instance.	MANY		View ≪featuredInEvent≫ example Property ≪featuredInEvent≫ example `"featuredIn": [{ "@type": "CourseInstance", "name": "CS101 Summer 2009", "url": "http://101.cs.org" }]`
hasPart	CreativeWork Trip	Schema: Event Bioschemas: A sub-Training Material or externally referenced Training Material.	MANY		View ≪hasPart≫ example Property ≪hasPart≫ example `"hasPart": [ { "@type": "CreativeWork", "url": "http://directoryVisuals.io", "name": "Shell Directory Visualizer" }, { "@type": "CreativeWork", "url": "http://shell.io", "name": "Interactive Shell tutorial" }]`
isPartOf	CreativeWork	Schema: Indicates a CreativeWork that this CreativeWork is (in some sense) part of. Inverse property: hasPart. Bioschemas: The Course in which this Training Material was/will be used, or the Training Material of which this Training Material is a part (e.g., the Training Material could be a chapter that isPartOf a book, or a slide-set that isPartOf a course). If this varies in CourseInstances, use the featuredIn property	MANY		View ≪isPartOf≫ example Property ≪isPartOf≫ example `"isPartOf": [{ "@type": "CreativeWork", "url": "http://computerScience4LS.org", "name": "The complete Computer Science for Life Scientists Coursebook" }]`
status	Text	Schema: The status of a training material. If this is not filled in it will be regarded as Active. Options are Active, Under development, and Archived.	ONE	Active Under development Archived	View ≪status≫ example Property ≪status≫ example `"status": "active"`
translatedInto	Thing	Schema: The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also availableLanguage. Supersedes language.	MANY		View ≪translatedInto≫ example Property ≪translatedInto≫ example `"translatedInto": [ "fr-FR" ]`
version	Number Text	Schema: The version of the CreativeWork embodied by a specified resource. Bioschemas: If this Training Material is versioned, it is strongly recommended that you use this property to indicate its version name or number.	ONE		View ≪version≫ example Property ≪version≫ example `"version": "0.2.0"`