Bindings for Stencila Schema

Documentation for package ‘stencilaschema’ version 1.0.0

Help Pages

-- A --

Any	Any type
Array	Array type
ArrayValidator	A validator specifying constraints on an array node.
Article	An article, including news and scholarly articles.
as_scalar	Declare that a node is scalar
as_type	Coerce a value to conform to the type Principally, marks values as scalar where possible
AudioObject	An audio file

-- B --

BlockContent	Union type for valid block content.
BooleanValidator	A schema specifying that a node must be a boolean value.
Brand	A brand used by an organization or person for labeling a product, product group, or similar.

-- C --

check_property	Check that a value is present if required and conforms to the specified type for a property.
Cite	A reference to a CreativeWork that is cited in another CreativeWork.
CiteGroup	A group of 'Cite' nodes
Code	Base type for code nodes e.g. 'CodeBlock', 'CodeExpression'.
CodeBlock	A code block.
CodeBlockTypes	All type schemas that are derived from CodeBlock
CodeChunk	A executable chunk of code.
CodeError	An error that occurred when parsing, compiling or executing a Code node.
CodeExpression	An expression defined in programming language source code.
CodeFragment	Inline code.
CodeFragmentTypes	All type schemas that are derived from CodeFragment
CodeTypes	All type schemas that are derived from Code
Collection	A created collection of CreativeWorks or other artefacts.
Comment	A comment on an item, e.g on a Article, or SoftwareSourceCode.
ConstantValidator	A validator specifying a constant value that a node must have.
ContactPoint	A contact point, for example, a R&D department.
ContactPointTypes	All type schemas that are derived from ContactPoint
CreativeWork	A creative work, including books, movies, photographs, software programs, etc.
CreativeWorkTypes	All type schemas that are derived from CreativeWork

-- D --

Datatable	A table of data.
DatatableColumn	A column of data within a Datatable.
Date	A date encoded as a ISO 8601 string.
DefinedTerm	A word, name, acronym, phrase, etc. with a formal definition.
Delete	Content that is marked for deletion

-- E --

Emphasis	Emphasised content.
Entity	The most simple compound (ie. non-atomic like 'number', 'string' etc) type.
EntityTypes	All type schemas that are derived from Entity
Enum	An enumeration
EnumValidator	A schema specifying that a node must be one of several values.

-- F --

Figure	Encapsulates one or more images, videos, tables, etc, and provides captions and labels for them.
Function	A function with a name, which might take Parameters and return a value of a certain type.

-- G --

Grant	A grant, typically financial or otherwise quantifiable, of resources.
GrantTypes	All type schemas that are derived from Grant

-- H --

-- I --

ImageObject	An image file.
Include	A directive to include content from an external source (e.g. file, URL) or content.
InlineContent	Union type for valid inline content.
IntegerValidator	A validator specifying the constraints on an integer node.
is_class	Is a value of a particular class
is_type	Does a value conform to the type?

-- L --

last_class	Get the last class for an object The last class is usually the "highest" in the inheritance tree
Link	A hyperlink to other pages, sections within the same document, resources, or any URL.
List	A list of items.
ListItem	A single item in a list.

-- M --

Mark	A base class for nodes that mark some other inline content in some way (e.g. as being emphasised, or quoted).
MarkTypes	All type schemas that are derived from Mark
Math	A mathematical variable or equation.
MathBlock	A block of math, e.g an equation, to be treated as block content.
MathFragment	A fragment of math, e.g a variable name, to be treated as inline content.
MathTypes	All type schemas that are derived from Math
MediaObject	A media object, such as an image, video, or audio object embedded in a web page or a downloadable dataset.
MediaObjectTypes	All type schemas that are derived from MediaObject
MonetaryGrant	A monetary grant.

-- N --

Node	Union type for all valid nodes.
NontextualAnnotation	Inline text that has a non-textual annotation.
NumberValidator	A validator specifying the constraints on a numeric node.
NumberValidatorTypes	All type schemas that are derived from NumberValidator

-- O --

An organization such as a school, NGO, corporation, club, etc.

-- P --

Paragraph	Paragraph
Parameter	A parameter that can be set and used in evaluated code.
Periodical	A periodical publication.
Person	A person (alive, dead, undead, or fictional).
PostalAddress	A physical mailing address.
Product	Any offered product or service. For example, a pair of shoes; a haircut; or an episode of a TV show streamed online.
PropertyValue	A property-value pair.
PublicationIssue	A part of a successively published publication such as a periodical or publication volume, often numbered.
PublicationVolume	A part of a successively published publication such as a periodical or multi-volume work.

-- Q --

Quote	Inline, quoted content.
QuoteBlock	A section quoted from somewhere else.

-- R --

A review of an item, e.g of an Article, or SoftwareSourceCode.

-- S --

SoftwareApplication	A software application.
SoftwareEnvironment	A computational environment.
SoftwareSession	Definition of a compute session, including its software and compute resource requirements and status.
SoftwareSourceCode	Computer programming source code. Example: Full (compile ready) solutions, code snippet samples, scripts, templates.
StringValidator	A schema specifying constraints on a string node.
Strong	Strongly emphasised content.
Subscript	Subscripted content.
Superscript	Superscripted content.

-- T --

Table	A table.
TableCell	A cell within a 'Table'.
TableRow	A row within a Table.
ThematicBreak	A thematic break, such as a scene change in a story, a transition to another topic, or a new document.
Thing	The most generic type of item.
ThingTypes	All type schemas that are derived from Thing
TupleValidator	A validator specifying constraints on an array of heterogeneous items.

-- U --

Union type

-- V --

ValidatorTypes	Union type for all validator types.
Variable	A variable representing a name / value pair.
VariableTypes	All type schemas that are derived from Variable
VideoObject	A video file.
VolumeMount	Describes a volume mount from a host to container.