matsbyname (version 0.6.11)

vectorize_byname: Vectorize a matrix

Description

Converts a matrix into a column vector. Each element of the matrix becomes an entry in the column vector, with rows named via the notation argument. Callers may want to transpose the matrix first with transpose_byname().

Usage

vectorize_byname(a, notation)

Value

A column vector containing all elements of a, with row names assigned as "rowname sep colname".

Arguments

a

The matrix to be vectorized.

notation

A string vector created by notation_vec().

Details

The notation is also applied to rowtype and coltype attributes.

Examples

m <- matrix(c(1, 5,
              4, 5),
            nrow = 2, ncol = 2, byrow = TRUE, 
            dimnames = list(c("p1", "p2"), c("i1", "i2"))) %>% 
  setrowtype("Products") %>% setcoltype("Industries")
m
vectorize_byname(m, notation = RCLabels::arrow_notation)
# If a single number is provided, the number will be returned as a 1x1 column vector 
# with some additional attributes.
vectorize_byname(42, notation = RCLabels::arrow_notation)
attributes(vectorize_byname(42, notation = RCLabels::arrow_notation))