mlr3 (version 0.1.2)

DataBackendMatrix: DataBackend for Matrix

Description

DataBackend for Matrix. Data is stored as (sparse) matrix.

Format

R6::R6Class object inheriting from DataBackend.

Construction

DataBackendMatrix$new(data, primary_key = NULL)
as_data_backend(data, primary_key = NULL, ...)

• data :: Matrix::Matrix().

• primary_key :: character(1) Not supported by this backend. Rows are addresses by their rownames(). If the matrix does not have row names, integer row indices are used.

Fields

See DataBackend.

Methods

See DataBackend.

See Also

Other DataBackend: DataBackendDataTable, DataBackend, as_data_backend

Examples

# NOT RUN {
requireNamespace("Matrix")
data = Matrix::Matrix(sample(0:1, 20, replace = TRUE), ncol = 2)
colnames(data) = c("x1", "x2")
rownames(data) = paste0("row_", 1:10)

b = as_data_backend(data)
b$head()
b$data(b$rownames[1:3], b$colnames, data_format = "Matrix")
# }