Skip to contents

Tensor-contract record.

Source: R/contract_ux.R
tensor_contract.Rd

Builds a tensor specification record for use in create_contract()'s tensors argument. A tensor is a 3-D structure stored as per-main-axis-entry matrices named <entry>_<name> on (rows_axis, columns_axis).

Usage

tensor_contract(
  main_axis,
  rows_axis,
  columns_axis,
  name,
  expectation,
  type,
  description
)

Arguments

main_axis

Axis whose entries index the tensor slices.

rows_axis, columns_axis

Axis names for each per-entry matrix.

name

Tensor name; individual matrices will be <main_axis_entry>_<name>.

expectation

One of the expectation-constants.

type

R class name of the matrix values (e.g. "integer", "numeric").

description

Free-text description.

Value

A list record with $kind = "tensor".

See also

create_contract(), axis_contract()

Examples

tensor_contract("batch", "cell", "gene", "UMIs",
    RequiredInput, "integer", "per-batch UMI matrices")
#> $kind
#> [1] "tensor"
#> 
#> $main_axis
#> [1] "batch"
#> 
#> $rows_axis
#> [1] "cell"
#> 
#> $columns_axis
#> [1] "gene"
#> 
#> $name
#> [1] "UMIs"
#> 
#> $expectation
#> [1] "RequiredInput"
#> 
#> $type
#> [1] "integer"
#> 
#> $description
#> [1] "per-batch UMI matrices"
#>