biolinkml is a general purpose modeling language following object-oriented and ontological principles. Models are authored in YAML. A variety of artefacts can be generated from the model, including ShEx, JSON-Schema, OWL, Python dataclasses, UML diagrams, Markdown pages for deployment in a GitHub pages site, and more.
biolinkml is used for development of the BioLink Model, but the framework is general purpose and can be used for any kind of modeling.
Quickstart docs:
- Browse the model (biolinkml is self-describing): https://biolink.github.io/biolinkml/docs
- class definition Class definitions
- slot definition Class properties
- type definition Data types
- schema ddefinition Schema definition
For an example, see the Jupyter notebook example
> pipenv install biolinkmlThis basic example shows a schema with a single class together with slots that can be used for instances of that class:
id: http://example.org/sample/example1
name: synopsis2
types:
yearCount:
base: int
uri: xsd:int
string:
base: str
uri: xsd:string
classes:
person:
description: A person, living or dead
slots:
- id
- first name
- last name
- age
slots:
id:
description: Unique identifier of a person
identifier: true
first name:
description: The first name of a person
range: string
last name:
description: The last name of a person
range: string
required: true
age:
description: The age of a person if living or age of death if not
range: yearCount- Python 3 dataclasses
- ShEx - Shape Expressions Langauge
- YUML - UML diagram drawing tool
- Class and interface definitions for GraphQL
- Graphviz -- fairly basic representation of hierarchies
- JSON and JSON-LD
- JSON Schema
- Markdown - markup language used by github and others
- OWL - Web Ontology Language
- RDF - Resource Description Format
In future we will have examples for each of these.
- polymorphism/inheritance, see is_a
- abstract and mixin classes
- control JSON-LD mappings to URIs via prefixes declarations
- ability to refine meaning of a slot in the context of a particular class via slot usage
These are specified using First Order Logic (FOL) axioms. See the semantics folder
Why invent our own yaml and not use JSON-Schema, SQL, UML, ProtoBuf, OWL, ...
each of these is tied to a particular formalisms. E.g. JSON-Schema to trees. OWL to open world logic. There are various impedance mismatches in converting between these. The goal was to develop something simple and more general that is not tied to any one serialization format or set of assumptions.
There are other projects with similar goals, e.g https://github.com/common-workflow-language/schema_salad
It may be possible to align with these.
Here X may be bioschemas, some upper ontology (BioTop), UMLS metathesaurus, bio*, various other attempts to model all of biology in an object model.
Currently as far as we know there is no existing reference datamodel that is flexible enough to be used here.
typeof:
domain: type definition
range: type definition
description: supertype
base:
domain: type definition
description: python base type that implements this type definition
inherited: true
type uri:
domain: type definition
range: uri
alias: uri
description: the URI to be used for the type in semantic web mappings
repr:
domain: type definition
range: string
description: the python representation of this type if different than the base type
inherited: true