Axis-contract record.

Builds an axis specification record for use in create_contract()'s axes argument.

Usage

axis_contract(name, expectation, description)

Arguments

name

Axis name.

expectation

One of the expectation-constants (e.g. RequiredInput, CreatedOutput).

description

Free-text description (character scalar).

Value

A list record with class "dafr_axis_contract".

See also

create_contract(), tensor_contract(), expectation-constants

Examples

axis_contract("cell", RequiredInput, "per-cell axis")
#> $kind
#> [1] "axis"
#> 
#> $name
#> [1] "cell"
#> 
#> $expectation
#> [1] "RequiredInput"
#> 
#> $description
#> [1] "per-cell axis"
#> 
#> attr(,"class")
#> [1] "dafr_axis_contract"