Extend0fromModelMatrixInput {SSBtools} | R Documentation |
A specialized version of Extend0()
Description
Extend0fromModelMatrixInput()
is a specialized function that extends the input data based on the provided parameters.
It is designed specifically to work with input to ModelMatrix()
.
Usage
Extend0fromModelMatrixInput(
data,
freqName,
hierarchies,
formula,
dimVar,
extend0,
dVar = NULL,
avoidHierarchical = FALSE,
hierarchical_extend0 = !avoidHierarchical & is.null(hierarchies),
...
)
IsExtend0(extend0)
Arguments
data |
Input data frame |
freqName |
Name of (existing) frequency variable |
hierarchies |
List of hierarchies, which can be converted by |
formula |
A model formula |
dimVar |
The main dimensional variables and additional aggregating variables. This parameter can be useful when hierarchies and formula are unspecified. |
extend0 |
When |
dVar |
Optional. Specifies the |
avoidHierarchical |
Parameter passed to |
hierarchical_extend0 |
Specifies the |
... |
Further arguments to underlying functions. |
Details
-
Extend0fromModelMatrixInput()
: The main function that processes and extends input data according to the specified parameters. -
IsExtend0()
: A helper function that evaluates theextend0
parameter and returnsTRUE
orFALSE
, indicating whether the data should be extended.
Value
Extended data frame