`variableMatrix`¶

Collect one or more variables into a separate matrix table, and return the name of the table.

This is useful for extracting variables that will be used in matrix multiplications.

variableMatrix(
    varName1,
    [varName2,]
    […]
)

Arguments¶

varName1: The name of a variable in the projection node. This may be the name of a scalar (constant) or a time vector (proj).
varName2, …: More variable names. Optional.

Say the current projection node has the following results in the time vectors table (ProjArea):

We may use the variableMatrix() function to get a new matrix table containing only the variables we want, and in the order we want:

variableMatrix("VarA", "VarD", "VarB")

This will create a table in the output workbook for this projection node that looks like this:

Say the current projection node has the following results in the scalars table (Constants):

We may use the variableMatrix() function to get a new matrix table containing only the variables we want, and in the order we want:

variableMatrix("VarH", "VarF", "VarG")

This will create a table in the output workbook for this projection node that looks like this:

VarH	VarF	VarG
9	7	8

Note that there is only one row, because all the variable in the matrix are scalars.

Time vectors and scalars may be combined, e.g.:

variableMatrix("VarA", "VarE", "VarC")

This will create a table in the output workbook for this projection node that looks like this:

Note that the scalar VarE is repeated to match the number of rows dictated by the time vectors.