survmat: The survmat prediction contract

In survalis: Interpretable Survival Machine Learning Framework

The survmat prediction contract

Description

Internal constructor and validator for survmat, the single prediction container used by the verb-level predict() method. A survmat is an ⁠n x length(times)⁠ numeric matrix carrying its evaluation grid in the "times" attribute (column names "t=<time>" are kept for display and for backward compatibility with the ⁠*_survmat⁠ metric helpers) and the predicted quantity in the "quantity" attribute.

Usage

new_survmat(x, times, quantity = "survival")

validate_survmat(x)

as_survmat(x, times, quantity = "survival")

Arguments

x	A numeric matrix (or data frame / vector coercible to one) of predictions, one row per observation and one column per entry of times.
times	Numeric vector, strictly increasing and non-negative, of length ncol(x).
quantity	One of "survival", "risk", "chf", "hazard". Controls printing and the ⁠[0, 1]⁠ range check (applied to "survival" and "risk" only).

Details

new_survmat() builds the object without checks; validate_survmat() enforces the contract; as_survmat() is the checked constructor used internally after a learner's raw ⁠predict_*()⁠ output has been finalised.

Value

A survmat: a numeric matrix with class c("survmat", "matrix", "array"), attribute "times", and attribute "quantity".

survalis documentation built on Nov. 14, 2026, 5:10 p.m.