| TrendTM {TrendTM} | R Documentation |
Matrix Factorization for Multivariate Time Series Analysis
Description
It is the main function. It performs the factorization for a selected rank and a temporal structure with a selected tau if the selection is requested otherwise it is fixed
Usage
TrendTM(
Data_Series,
k_select = FALSE,
k_max = 20,
struct_temp = "none",
tau_select = FALSE,
tau_max = floor(n/2),
type_soft = "als"
)
Arguments
Data_Series |
the data matrix with d rows and n columns containing the d temporal series with size n. |
k_select |
a boolean indicating if the rank of the matrix Data_Series will be selected. Default is FALSE. |
k_max |
the fixed rank of Data_Series if |
struct_temp |
a name indicating the temporal structure. Could be |
tau_select |
a boolean indicating if the parameter tau will be selected. This can be possible only when |
tau_max |
the fixed value for tau if |
type_soft |
the option |
Details
The penalty constant(s) is(are) calibrated using the slope heuristic from package capushe. We adapt this heuristic as follows: the final dimension is the one correspind to the majority of the selected dimension for the considered different penalties.
Value
A list containing
-
k_estthe selected rank ifk_select==TRUEork_maxifk_select==FALSE. -
tau_estthe selected tau iftau_select==TRUEortau_maxiftau_select==FALSE. -
U_estthe component U of the decomposition of the final estimatorM_est. -
V_estthe component V of the decomposition of the final estimatorM_est. -
M_estthe estimation of M. -
contrastthe Frobenius norm of Data_Series-M_est. This is a value whenk_select==FALSEandtau_select==FALSE, a vector whenk_select==TRUEortau_select==TRUE, and a matrix whenk_select==TRUEandtau_select==TRUEwithk_maxrows andtau_maxcolumns.
Examples
data(Data_Series)
result <- TrendTM(Data_Series, k_max = 3)