create_matrix_byname {matsbyname} | R Documentation |
Create a "byname" matrix from a vector
Description
This function creates a "byname" matrix, or list of matrices, from .dat
,
depending on the input arguments.
This function is similar to matrix()
, but with "byname" characteristics.
Usage
create_matrix_byname(
.dat,
nrow,
ncol,
byrow = FALSE,
dimnames,
matrix_class = c("matrix", "Matrix")
)
Arguments
.dat |
The data to be used to create the matrix, in a list format, or as a data frame column containing a list of the data to be used for each observation. |
nrow |
The number of rows to be used to create the matrix, in a list format, or as a data frame column containing a list of the number of rows to be used for each observation. |
ncol |
The number of columns to be used to create the matrix, in a list format, or as a data frame column containing a list of the number of columns to be used for each observation. |
byrow |
The argument stating whether the matrix should be filled by rows or by columns (FALSE by column, TRUE by row),
in a list format, or as a data frame column containing a list of the byrow argument for each observation.
Default is |
dimnames |
The dimension names to be used for creating the matrices, in a list format, or as a data frame column containing a list of the dimension names to be used for each observation. |
matrix_class |
One of "matrix" or "Matrix".
"matrix" creates a |
Details
Row and column names are taken from the dimnames
argument.
Any row or column type information on .dat
is preserved on output.
The created object(s) can be of type base::matrix
or Matrix::Matrix
,
the latter enables sparse objects to save both memory and disk.
Value
A matrix, list of matrices, or column in a data frame, depending on the input arguments.
Examples
create_matrix_byname(c(1, 2), nrow = 2, ncol = 1,
dimnames = list(c("r1", "r2"), "c1"))
create_matrix_byname(list(1, 2), nrow = list(1, 1), ncol = list(1,1),
dimnames = list(list("r1", "c1"), list("R1", "C1")))