This type is marked as unstable and is subject to change.

Properties

The Parameter type has these properties:

Name	Description	Type	Inherited from	JSON-LD @id	Aliases
id	The identifier for this item.	String	Entity	schema:id	-
executionMode	Under which circumstances the node should be executed.	ExecutionMode	Executable	stencila:executionMode	execution-mode, execution_mode
compilationDigest	A digest of the content, semantics and dependencies of the node.	CompilationDigest	Executable	stencila:compilationDigest	compilation-digest, compilation_digest
compilationMessages	Messages generated while compiling the code.	CompilationMessage*	Executable	stencila:compilationMessages	compilation-messages, compilation_messages, compilationMessage, compilation-message, compilation_message
executionDigest	The compilationDigest of the node when it was last executed.	CompilationDigest	Executable	stencila:executionDigest	execution-digest, execution_digest
executionDependencies	The upstream dependencies of this node.	ExecutionDependency*	Executable	stencila:executionDependencies	execution-dependencies, execution_dependencies, executionDependency, execution-dependency, execution_dependency
executionDependants	The downstream dependants of this node.	ExecutionDependant*	Executable	stencila:executionDependants	execution-dependants, execution_dependants, executionDependant, execution-dependant, execution_dependant
executionTags	Tags in the code which affect its execution.	ExecutionTag*	Executable	stencila:executionTags	execution-tags, execution_tags, executionTag, execution-tag, execution_tag
executionCount	A count of the number of times that the node has been executed.	Integer	Executable	stencila:executionCount	execution-count, execution_count
executionRequired	Whether, and why, the code requires execution or re-execution.	ExecutionRequired	Executable	stencila:executionRequired	execution-required, execution_required
executionStatus	Status of the most recent, including any current, execution.	ExecutionStatus	Executable	stencila:executionStatus	execution-status, execution_status
executionInstance	The id of the kernel instance that performed the last execution.	String	Executable	stencila:executionInstance	execution-instance, execution_instance
executionEnded	The timestamp when the last execution ended.	Timestamp	Executable	stencila:executionEnded	execution-ended, execution_ended
executionDuration	Duration of the last execution.	Duration	Executable	stencila:executionDuration	execution-duration, execution_duration
executionMessages	Messages emitted while executing the node.	ExecutionMessage*	Executable	stencila:executionMessages	execution-messages, execution_messages, executionMessage, execution-message, execution_message
name	The name of the parameter.	String	-	schema:name	-
label	A short label for the parameter.	String	-	stencila:label	-
value	The current value of the parameter.	Node	-	schema:value	-
default	The default value of the parameter.	Node	-	schema:defaultValue	-
validator	The validator that the value is validated against.	Validator	-	stencila:validator	-
derivedFrom	The dotted path to the object (e.g. a database table column) that the parameter should be derived from	String	-	stencila:derivedFrom	derived-from, derived_from

Related

The Parameter type is related to these types:

• Parents: Executable
• Children: CallArgument

Formats

The Parameter type can be encoded (serialized) to, and/or decoded (deserialized) from, these formats:

Format	Encoding	Decoding	Support	Notes
DOM HTML	🟢 No loss
HTML	🔷 Low loss		Encoded using special function
JATS			Encoded as <parameter>
Markdown	🔷 Low loss	🔷 Low loss	Encoded using implemented function
Stencila Markdown	🔷 Low loss	🔷 Low loss
Quarto Markdown	🔷 Low loss	🔷 Low loss
MyST Markdown	🔷 Low loss	🔷 Low loss
LLM Markdown	🔷 Low loss	🔷 Low loss
LaTeX	🔷 Low loss	🔷 Low loss
PDF	🔷 Low loss
Plain text	⚠️ High loss
IPYNB	🔷 Low loss	🔷 Low loss
Microsoft Word DOCX	🔷 Low loss	🔷 Low loss
OpenDocument ODT	🔷 Low loss	🔷 Low loss
TeX	🔷 Low loss	🔷 Low loss
JSON	🟢 No loss	🟢 No loss
JSON+Zip	🟢 No loss	🟢 No loss
JSON5	🟢 No loss	🟢 No loss
JSON-LD	🟢 No loss	🟢 No loss
CBOR	🟢 No loss	🟢 No loss
CBOR+Zstandard	🟢 No loss	🟢 No loss
YAML	🟢 No loss	🟢 No loss
Lexical JSON	🔷 Low loss	🔷 Low loss
Koenig JSON	🔷 Low loss	🔷 Low loss
Pandoc AST	🔷 Low loss	🔷 Low loss
Directory
Stencila Web Bundle
Debug	🔷 Low loss

Bindings

The Parameter type is represented in:

• JSON-LD
• JSON Schema
• Python class Parameter
• Rust struct Parameter
• TypeScript class Parameter

Testing

During property-based (a.k.a generative) testing, the properties of the Parameter type are generated using the following strategies for each complexity level. Any optional properties that are not in this table are set to None.

Property	Complexity	Description	Strategy
name	Min+	Generate a fixed name.	String::from("name")
	Low+	Generate a random string of up to 10 alphanumeric characters (and at most one underscore to avoida clash with Markdown emphasis).	Regex [a-zA-Z_][a-zA-Z0-9]{0,9}
	High+	Generate a random string of up to 100 characters (excluding control characters).	Regex [^\p{C}]{1,100}
	Max	Generate an arbitrary string.	String::arbitrary()

Source

This documentation was generated from Parameter.yaml by docs_types.rs.