Skip to contents

Element-wise scalar data of a ModelArray object

scalars.Rd

Retrieve scalar matrices from a ModelArray. When called with no additional arguments, returns the full named list of all scalar matrices. When called with a single scalar name, returns that one matrix.

Usage

scalars(x, ...)

# S4 method for class 'ModelArray'
scalars(x, ...)

Arguments

x

A ModelArray object.

...

Optional: a single character string giving the scalar name to extract. If omitted, the entire named list is returned.

Value

If called with no extra arguments, a named list of DelayedArray::DelayedArray matrices (elements as rows, source files as columns). If called with a scalar name, the corresponding single DelayedArray::DelayedArray matrix.

See also

sources, results, scalarNames, nElements

Examples

if (FALSE) { # \dontrun{
ma <- ModelArray("data.h5", scalar_types = c("FD", "FC"))
scalars(ma) # named list of all scalars
scalars(ma, "FD") # single DelayedArray matrix
} # }