FormalParameter DRAFT Profile

Version: 0.1-DRAFT-2020_07_21 (21 July 2020)

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.

Schema.org hierarchy

This Profile fits into the schema.org hierarchy as follows:

Thing > Intangible > FormalParameter

Description

A FormalParameter is an identified variable used to stand for the actual value(s) are consumed/produced by a ComputationalWorkflow

Latest profiles

Latest release: 1.0-RELEASE

Latest draft: 1.1-DRAFT

Previous profiles

Previous version: 0.1-DRAFT-2020_06_23

Contributors

The following people have been involved in the creation of this specification document. They are all members of the Workflow group.

Group Leader(s)

Alan Williams

Stuart Owen

Bert Droesbeke

Other team members

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

You can read the release version of this specification here.

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		Property ≪@context≫ example `{ "@context": "https://schema.org/" }`
@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	Property ≪@type≫ example `{ "@type": "FormalParameter" }`
@id	IRI	Used to distinguish the resource being described in JSON-LD. For other serialisations use the appropriate approach.	ONE		Property ≪@id≫ example `{ "@id": "http://example.com/entity/A12345" }`
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	Property ≪dct:conformsTo≫ example `{ "http://purl.org/dc/terms/conformsTo": { "@id": "https://bioschemas.org/profiles/FormalParameter/0.1-DRAFT-2020_07_21", "@type": "CreativeWork" } }`
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.	ONE	http://edamontology.org/data_0006
encodingFormat	Text URL	Schema: URLs to accepted formats	MANY	http://edamontology.org/format_1915
name	Text	Schema: The name of the item.	ONE
Marginality: Recommended.
description	Text	Schema: A description of the item. Bioschemas: The description may include verbatim the Workflow’s description of the FormalParameter and its type	ONE
Marginality: Optional.
defaultValue	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.	MANY
valueRequired	Boolean	Schema: If the FormalParameter must be specified. This is commonly only used for Inputs	ONE