FormalParameter Profile
Version: 1.0-RELEASE (09 March 2021)
Bioschemas specification for describing a formal parameter in the Life Sciences.
If you spot any errors or omissions with this type, please file an issue in our GitHub.
Key to specification table
- Green properties/types are proposed by Bioschemas, or indicate proposed changes by Bioschemas to Schema.org
- Red properties/types exist in the core of Schema.org
- Blue properties/types exist in the pending area of Schema.org
- Black properties/types are reused from external vocabularies/ontologies
CD = Cardinality
Property | Expected Type | Description | CD | Controlled Vocabulary | Example |
---|---|---|---|---|---|
Marginality: Minimum. | |||||
@context | URL | Used to provide the context (namespaces) for the JSON-LD file. Not needed in other serialisations. |
ONE | ||
@type | Text | Schema.org/Bioschemas class for the resource declared using JSON-LD syntax. For other serialisations please use the appropriate mechanism. While it is permissible to provide multiple types, it is preferred to use a single type. |
MANY | Schema.org, Bioschemas | |
@id | IRI | Used to distinguish the resource being described in JSON-LD. For other serialisations use the appropriate approach. | ONE | ||
dct:conformsTo | IRI | Used to state the Bioschemas profile that the markup relates to. The versioned URL of the profile must be used. Note that we use a CURIE in the table here but the full URL for Dublin Core terms must be used in the markup (http://purl.org/dc/terms/conformsTo), see example. |
ONE | Bioschemas profile versioned URL | |
name |
Text |
Schema: The name of the item. |
ONE | ||
Marginality: Recommended. | |||||
additionalType |
URL |
Schema: An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the ‘typeof’ attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. Bioschemas: The type of data consumed / produced at the FormalParameter. It is strongly recommented that this be specified. If it is not specified, then nothing should be assumed about the type of the FormalParameter. |
MANY | http://edamontology.org/data_0006 |
|
description |
Text |
Schema: A description of the item. Bioschemas: The description may include verbatim the ComputationalWorkflow’s description of the FormalParameter and its type |
ONE | ||
encodingFormat |
Text URL |
Schema: Media type typically expressed using a MIME format (see IANA site and MDN reference) e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.). In cases where a CreativeWork has several media type representations, encoding can be used to indicate each MediaObject alongside particular encodingFormat information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. Bioschemas: URLs to accepted formats. It is strongly recommented that this be specified. If it is not specified, then nothing should be assumed about the encoding formats of the FormalParameter. |
MANY | http://edamontology.org/format_1915 |
|
Marginality: Optional. | |||||
defaultValue |
Text Thing |
Schema: The default value for the FormalParameter. This is commonly only used for Inputs. |
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. Bioschemas: Note that this is identification of what is produced / consumed by the FormalParameter. The identifier may, for example, indicate a gene position that is expected to be read. The value supplied as the actual value will be read from that position. |
MANY | ||
valueRequired |
Boolean |
Schema: If the FormalParameter must be specified. This is commonly only used for Inputs |
ONE |