DRAFT Specification v. 0.0.1

Description Links

Description

This Container profile specification presents a representation of a Container such as Docker or Singularity that is used in scientific compute.

Schema.org hierarchy

This is a new Profile that fits into the schema.org hierarchy as follows:

Thing > CreativeWork > SoftwareSourceCode

Group	Use Cases	Task & Issues	Examples

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: applicationCategory
{   "@type": ["SoftwareApplication", "Container"],   "applicationCategory": "singularity" }


//Property: citation
{ "@type": ["SoftwareApplication", "Tool"], "citation": "https://dx.doi.org/10.1016/S0022-2836(05)80360-2" }


//Property: dateCreated
{ "@type": ["SoftwareApplication", "Tool"], "dateCreated": "2108-06-13" }


//Property: dateModified
{ "@type": ["SoftwareApplication", "Tool"], "dateModified": "2108-08-07" }


//Property: downloadUrl
{   "@type": ["SoftwareApplication", "Tool"],   "downloadURL": "https://github.com/sacdallago/cellmap" }


//Property: featureList
{   "@type": ["SoftwareApplication", "Tool"],   "featureList": ["http://edamontology.org/topic_0821", "http://edamontology.org/topic_0128"] }


//Property: identifier
<username>/<repository>:<tag>@<hash>


//Property: input
{ "@type": ["SoftwareApplication", "Tool"], "input": ["http://edamontology.org/data_2977", "http://edamontology.org/data_2976"] }


//Property: keywords
{ "@type": ["SoftwareApplication", "Tool"], "ketwords": "Biology, chemistry, medicine" }


//Property: license
{ "@type": ["SoftwareApplication", "Tool"], "license": "https://www.apache.org/licenses/LICENSE-2.0" }


//Property: operatingSystem
{   "@type": ["SoftwareApplication", "Tool"],   "operatingSystem": ["Windows 7 or above", "Linux/Unix", "Mac/Apple"] }


//Property: output
{ "@type": ["SoftwareApplication", "Tool"], "input": ["http://edamontology.org/data_1383", "http://edamontology.org/data_1384"] }


//Property: publisher
{   "@type": ["SoftwareApplication", "Tool"],   "publisher": {     "@type": "Organization",     "name": "National Center for Biotechnology Information National Library of Medicine",     "alternatName": "NCBI NLM"   } }


//Property: softwareHelp
{   "@type": ["SoftwareApplication", "Tool"],   "softwareHelp": "https://biotools.readthedocs.io/en/latest/" }


//Property: softwareRequirements
{   "@type": ["SoftwareApplication", "Tool"],   "softwareRequirements": "JRE 8.0 or above" }


//Property: softwareVersion
{   "@type": ["SoftwareApplication", "Tool"],   "softwareVersion": "1.0.2" }

Property	Expected Type	Description	CD	Controlled Vocabulary	Example
Marginality: Minimum.
description	Text	Schema: A description of the item. OpenSchemas: a linux container	ONE
featureList	Text URL	Schema: Features or modules provided by this application (and possibly required by other applications). OpenSchemas: Please choose values from EDAM:Operation.	MANY	EDAM:Operation	View ≪featureList≫ example Property ≪featureList≫ example `{ "@type": ["SoftwareApplication", "Tool"], "featureList": ["http://edamontology.org/topic_0821", "http://edamontology.org/topic_0128"] }`
name	Text	Schema: The name of the item.	ONE
softwareVersion	Text	Schema: Version of the software instance. OpenSchemas: version of the container instance	ONE		View ≪softwareVersion≫ example Property ≪softwareVersion≫ example `{ "@type": ["SoftwareApplication", "Tool"], "softwareVersion": "1.0.2" }`
url	URL	Schema: URL of the item. OpenSchemas: URL of the container, typically associated with a registry that shows the ContainerRecipe, vulnerability scans, and other metadata. This property can be used on a page listing many containers to indicate each individual container’s page.	ONE
Marginality: Recommended.
ContainerImage	ContainerImage	Schema: A ContainerImage is the binary or associated shasum that references a particular grouping of layers to form a complete images. OpenSchemas: A ContainerImage is the binary or associated shasum that references a particular grouping of layers to form a complete images.	ONE
alternateName	Text	Schema: An alias for the item.	MANY
brands	Text	Schema: The command for a ContainerRecipe is typically a set of extra arguments that are added to the entrypoint in a default running scenario OpenSchemas: The command for a ContainerRecipe is typically a set of extra arguments that are added to the entrypoint in a default running scenario	MANY
brands	Text	Schema: a special list of keywords to describe the underlying technologies (e.g., Docker) that the container recipe affords building. OpenSchemas: a special list of keywords to describe the underlying technologies (e.g., Docker) that the container recipe affords building.	MANY
citation	CreativeWork Text	Schema: A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. OpenSchemas: Publication about this software.	MANY		View ≪citation≫ example Property ≪citation≫ example `{ "@type": ["SoftwareApplication", "Tool"], "citation": "https://dx.doi.org/10.1016/S0022-2836(05)80360-2" }`
entrypoint	Text	Schema: The entrypoint is the executable that is called within the container when the user executes it, typically via a “run” or equivalent command. OpenSchemas: The entrypoint is the executable that is called within the container when the user executes it, typically via a “run” or equivalent command.	MANY
help	Text	Schema: A help section is not present for all container technologies, but is typically a blurb of text that can be shown to the user to give detais about runtime usage or similar. OpenSchemas: A help section is not present for all container technologies, but is typically a blurb of text that can be shown to the user to give detais about runtime usage or similar.	ONE
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. OpenSchemas: Unique identifier for the container, typically corresponding to a uri to designate a registry source	ONE		View ≪identifier≫ example Property ≪identifier≫ example `<username>/<repository>:<tag>@<hash>`
input	URL	Schema: The input format of the data. Must be one of the EDAM:Data concept labels or one of its synonyms. OpenSchemas: The input format of the data. Must be one of the EDAM:Data concept labels or one of its synonyms.	MANY	EDAM:Data	View ≪input≫ example Property ≪input≫ example `{ "@type": ["SoftwareApplication", "Tool"], "input": ["http://edamontology.org/data_2977", "http://edamontology.org/data_2976"] }`
keywords	Text	Schema: Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. OpenSchemas: a list of keywords to describe the ContainerImage that the ContainerRecipe will build	MANY
labels	Text	Schema: Labels are a list of key, value pairs that encompass named metadata for the container. OpenSchemas: Labels are a list of key, value pairs that encompass named metadata for the container.	MANY
license	Text URL	Schema: A license document that applies to this content, typically indicated by URL. OpenSchemas: The applicable software license. Note: Bioschemas have changed the Expected Types to URL or Text.	MANY		View ≪license≫ example Property ≪license≫ example `{ "@type": ["SoftwareApplication", "Tool"], "license": "https://www.apache.org/licenses/LICENSE-2.0" }`
output	URL	Schema: The output format of the data OpenSchemas: The output format of the data. Must be one of the EDAM:Data concept labels or one of its synonyms.	MANY	EDAM:Data	View ≪output≫ example Property ≪output≫ example `{ "@type": ["SoftwareApplication", "Tool"], "input": ["http://edamontology.org/data_1383", "http://edamontology.org/data_1384"] }`
publisher	Organization Person	Schema: The publisher of the creative work.	MANY		View ≪publisher≫ example Property ≪publisher≫ example `{ "@type": ["SoftwareApplication", "Tool"], "publisher": { "@type": "Organization", "name": "National Center for Biotechnology Information National Library of Medicine", "alternatName": "NCBI NLM" } }`
Marginality: Optional.
applicationCategory	Text	Schema: Type of software application, e.g. ‘Game, Multimedia’. OpenSchemas: Type of software e.g. database, tool, service. Note: Bioschemas have removed URL from the Expected Types.	MANY	Please indicate the container technology in all lowercase	View ≪applicationCategory≫ example Property ≪applicationCategory≫ example `{ "@type": ["SoftwareApplication", "Container"], "applicationCategory": "singularity" }`
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 `{ "@type": ["SoftwareApplication", "Tool"], "dateCreated": "2108-06-13" }`
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 `{ "@type": ["SoftwareApplication", "Tool"], "dateModified": "2108-08-07" }`
downloadUrl	URL	Schema: If the file can be downloaded, URL to download the binary. For containers without an exposed wget url or similar, this can be the pull command.	MANY		View ≪downloadUrl≫ example Property ≪downloadUrl≫ example `{ "@type": ["SoftwareApplication", "Tool"], "downloadURL": "https://github.com/sacdallago/cellmap" }`
hasPart	CreativeWork	Schema: Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). OpenSchemas: Used to describe tools included into suites/bundles/workflows.	MANY
keywords	Text	Schema: Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.	ONE	EDAM:Topic	View ≪keywords≫ example Property ≪keywords≫ example `{ "@type": ["SoftwareApplication", "Tool"], "ketwords": "Biology, chemistry, medicine" }`
operatingSystem	Text	Schema: Operating systems supported (Windows 7, OSX 10.6, Android 1.6). OpenSchemas: Operating systems on which the container runs, typically Linux derivatives and (for some containers) Windows.	MANY		View ≪operatingSystem≫ example Property ≪operatingSystem≫ example `{ "@type": ["SoftwareApplication", "Tool"], "operatingSystem": ["Windows 7 or above", "Linux/Unix", "Mac/Apple"] }`
softwareHelp	CreativeWork	Schema: Software application help. OpenSchemas: A documentation for the container, typically showing install steps, usage, and a changelog.	MANY		View ≪softwareHelp≫ example Property ≪softwareHelp≫ example `{ "@type": ["SoftwareApplication", "Tool"], "softwareHelp": "https://biotools.readthedocs.io/en/latest/" }`
softwareRequirements	Text URL	Schema: Component dependency requirements for application. This includes runtime environments and shared libraries that are not included in the application distribution package, but required to run the application (Examples: DirectX, Java or .NET runtime). Supersedes requirements.	MANY		View ≪softwareRequirements≫ example Property ≪softwareRequirements≫ example `{ "@type": ["SoftwareApplication", "Tool"], "softwareRequirements": "JRE 8.0 or above" }`