Skip to contents

Render a contract as a human-readable multi-line string.

Source: R/computations.R
contract_description.Rd

Intended for splicing into roxygen docstrings of functions created by computation(). Sections rendered: axes (with expectation + description), scalars, vectors (per axis), matrices (per axis pair).

Usage

contract_description(contract)

Arguments

contract

A Contract.

Value

A character scalar.

See also

computation(), Contract().

Examples

c <- Contract(
    axes = list(cell = list(RequiredInput, "per-cell axis")),
    data = list(contract_vector("cell", "donor",
        RequiredInput, "character", "donor id"))
)
cat(contract_description(c))
#> Axes:
#>   cell (RequiredInput): per-cell axis
#> Vectors:
#>   cell / donor (RequiredInput, character): donor id