rolwinmulcor_1win: Estimate the Rolling Window Correlation for the multi-variate...

Description Usage Arguments Details Value Author(s) References Examples

View source: R/rolwinmulcor_1win.R


The rolwinmulcor_1win function estimates the rolling window correlation coefficients and their respective p-values among multiple time series (multi-variate case) sampled on identical time points for ONLY ONE window-length (time-scale). The multi-variate case is based on the concept of multiple regression and generalizes the standard coefficient of correlation (the squared multiple correlation coefficient, or more appropriate, the adjusted coefficient of determination, R^2). We follow to Abdi (2007) to implement computationally this technique. The rolwinmulcor_1win function is highly flexible since this contains several parameters to control the estimation of correlation. For example, rolwinmulcor_1win function contains parameters to remove the (linear) trend contained in the time series under analysis, to choose different p-value correction methods (which are used to address the multiple comparison problem). A list of parameters are described in the following lines.


rolwinmulcor_1win(inputdata, varnametsY="", varnametsX="", widthwin=5, 
                  Align="center", pvalcorectmethod="BH", 
                  rmltrd="TRUE", Scale="TRUE")



Matrix of P columns: time, dependent variable (Y), and independent variables (X_1, X_2,..., X_{P-2}).


Name of the dependent variable: Y. Please note that the name of this variable MUST be defined.


Name of the independent variables: X_1, X_2,..., X_{p-2}. Please note that the names of these variables MUST defined in this way: varnametsX=paste("X1", "X2",..., sep=", ").


Remove (by default is “TRUE”; “FALSE” otherwise) the linear trend in the time series under analysis.


Scale (by default is “TRUE”; “FALSE” otherwise) is used to “normalize” or “standardize” the time series under analysis.


Window size to compute the rolling window correlations. This value can be an even or odd number of at least three (the default value), and this parameter MUST be provided.


To align the rolling object, RolWinMulCor ONLY uses the “center” option by default (please look at: R>?running) to ensure that variations in the correlation are aligned with the variations in the relationship of the time series under study rather than being shifted (Polanco-Martínez, 2019; 2020), but the “left” and “right” options can be used, but if widthwin is an even number it will not be possible to use the “center” option (please look at: R>?running).


The p-value correction method to be used, by default the method of Benjamini and Hochberg (BH) (1995) is used since this is less conservative and performs much better than Bonferroni, but other five methods (Holm, Hochberg, Bonferroni,Hommel, and Benjamini and Yekutieli) are available (please look at: R>?p.adjust). Moreover, pvalcorectmethod admits a pass-through option named “none” (p-values will not be corrected).


The rolwinmulcor_1win function estimates the rolling window correlation coefficients and their respective p-values among multiple time series (multi-variate case) sampled on identical time points for ONLY ONE window-length. rolwinmulcor_1win uses the functions rollapply (package:zoo) that is able to tackle matrices, the native R function p.adjust (package:stats), and some pieces of code and an auxiliary function that we have created specifically for our function rolwinmulcor_1win and RolWinMulCor R package.



Numerical output: three list containing Correlation_coefficients, P_values_corrected, and P_values_not_corrected, which are self-explanatory, as well as left_win, righ_win, and widthwin, which indicate the method used to estimate the correlations, first and last time element of the rolling correlation matrix, and the window-length (time-scale).


Josué M. Polanco-Martínez (a.k.a. jomopo).
DeustoTech - Deusto Institute of Technology,
Faculty of Engineering, University of Deusto,
Avda. Universidades, 24, Bilbao, SPAIN.


Abdi H. Multiple correlation coefficient, in Encyclopedia of Measurement and Statistics, N. J. Salkind, Ed. Sage, Thousand Oaks, CA, USA, 2007; 648-651.

Benjamini, Y., and Hochberg, Y. (1995). Controlling the false discovery rate: a practical and powerful approach to multiple testing. Journal of the Royal Statistical Society Series B, 57 (1), 289-300. <URL:>.

Polanco-Martínez, J. M. (2019). Dynamic relationship analysis between NAFTA stock markets using nonlinear, nonparametric, non-stationary methods. Nonlinear Dynamics, 97(1), 369-389. <URL:>.

Polanco-Martínez, J. M. (2020). RolWinMulCor : an R package for estimating rolling window multiple correlation in ecological time series. Ecological Informatics (Ms. ECOINF-D-20-00263 accepted for publication, 19/08/2020).


 # Testing the function rolwinmulcor_1win (multi-variate case)
 test_rolwinmulcor_1win <- rolwinmulcor_1win(YX_ecological_data, widthwin=61,
                            Align="center", pvalcorectmethod="BH")

RolWinMulCor documentation built on Aug. 31, 2020, 5:06 p.m.