Learn R Programming

generalCorr (version 1.2.6)

Generalized Correlations, Causal Paths and Portfolio Selection

Description

Function gmcmtx0() computes a more reliable (general) correlation matrix. Since causal paths from data are important for all sciences, the package provides many sophisticated functions. causeSummBlk() and causeSum2Blk() give easy-to-interpret causal paths. Let Z denote control variables and compare two flipped kernel regressions: X=f(Y, Z)+e1 and Y=g(X, Z)+e2. Our criterion Cr1 says that if |e1*Y|>|e2*X| then variation in X is more "exogenous or independent" than in Y, and the causal path is X to Y. Criterion Cr2 requires |e2|<|e1|. These inequalities between many absolute values are quantified by four orders of stochastic dominance. Our third criterion Cr3, for the causal path X to Y, requires new generalized partial correlations to satisfy |r*(x|y,z)|< |r*(y|x,z)|. The function parcorVec() reports generalized partials between the first variable and all others. The package provides several R functions including get0outliers() for outlier detection, bigfp() for numerical integration by the trapezoidal rule, stochdom2() for stochastic dominance, pillar3D() for 3D charts, canonRho() for generalized canonical correlations, depMeas() measures nonlinear dependence, and causeSummary(mtx) reports summary of causal paths among matrix columns. Portfolio selection: decileVote(), momentVote(), dif4mtx(), exactSdMtx() can rank several stocks. Functions whose names begin with 'boot' provide bootstrap statistical inference, including a new bootGcRsq() test for "Granger-causality" allowing nonlinear relations. A new tool for evaluation of out-of-sample portfolio performance is outOFsamp(). Panel data implementation is now included. See eight vignettes of the package for theory, examples, and usage tips. See Vinod (2019) \doi{10.1080/03610918.2015.1122048}.

Copy Link

Version

Install

install.packages('generalCorr')

Monthly Downloads

478

Version

1.2.6

License

GPL (>= 2)

Maintainer

Hrishikesh Vinod

Last Published

October 9th, 2023

Functions in generalCorr (1.2.6)

abs_stdapdC

Absolute values of gradients (apd's) of kernel regressions of x on y when both x and y are standardized and control variables are present.
bootPair2

Compute matrix of n999 rows and p-1 columns of bootstrap `sum' (scores from Cr1 to Cr3).
bigfp

Compute the numerical integration by the trapezoidal rule.
bootSign

Probability of unambiguously correct (+ or -) sign from bootPairs output
bootSignPcent

Probability of unambiguously correct (+ or -) sign from bootPairs output transformed to percentages.
bootDom12

bootstrap confidence intervals for (x2-x1) exact SD1 to SD4 stochastic dominance .
abs_stdrhserC

Absolute residuals kernel regressions of standardized x on y and control variables, Cr1 has abs(RHS*y) not gradients.
abs_stdrhserr

Absolute values of Hausman-Wu null in kernel regressions of x on y when both x and y are standardized.
bootPairs

Compute matrix of n999 rows and p-1 columns of bootstrap `sum' (strength from Cr1 to Cr3).
bootGcRsq

Compute vector of n999 nonlinear Granger causality paths
bootGcLC

Compute vector of n999 nonlinear Granger causality paths
causeSummBlk

Block Version 2: Kernel causality summary of causal paths from three criteria
causeSumNoP

No print (NoP) version of causeSummBlk summary causal paths from three criteria
causeSummary

Kernel causality summary of evidence for causal paths from three criteria
bootPairs0

Compute matrix of n999 rows and p-1 columns of bootstrap `sum' index (strength from older criterion Cr1, with newer Cr2 and Cr3).
bootQuantile

Compute confidence intervals [quantile(s)] of indexes from bootPairs output
causeSummary0

Older Kernel causality summary of evidence for causal paths from three criteria
causeAllPair

All Pair Version Kernel (block) causality summary paths from three criteria
canonRho

Generalized canonical correlation, estimating alpha, beta, rho.
da2Lag

internal da2Lag
causeSum2Blk

Block Version 2: Kernel causality summary of causal paths from three criteria
decileVote

Function compares nine deciles of stock return distributions.
causeSum2Panel

Kernel regressions based causal paths in Panel Data.
causeSummary2NoP

No Print version Kernel causality summary of evidence for causal paths from three criteria using new exact stochastic dominance.
causeSummary2

Kernel causality summary of evidence for causal paths from three criteria using new exact stochastic dominance. The function develops a unanimity index for deciding which flip (y on xi) or (xi on y) is best. Relevant signs determine the causal direction and unanimity index among three criteria. While allowing the researcher to keep some variables as controls, or outside the scope of causal path determination (e.g., age or latitude) this function produces detailed causal path information in a 5 column matrix identifying the names of variables, causal path directions, path strengths re-scaled to be in the range [--100, 100], (table reports absolute values of the strength) plus Pearson correlation and its p-value. The `2' in the name of the function suggests a second implementation where exact stochastic dominance, decileVote, and momentVote are used and where we avoid Anderson's trapezoidal approximation.
depMeas

depMeas Signed measure of nonlinear nonparametric dependence between two vectors.
bootSummary

Compute usual summary stats of 'sum' indexes from bootPairs output
dif4

order 4 differencing of a time series vector
bootSummary2

Compute usual summary stats of 'sum' index in (-100, 100) from bootPair2
gmc0

internal gmc0
cofactor

Compute cofactor of a matrix based on row r and column c.
gmc1

internal gmc1
get0outliers

Function to compute outliers and their count using Tukey's method using 1.5 times interquartile range (IQR) to define boundaries.
compPortfo

Compares two vectors (portfolios) using momentVote, DecileVote and exactSdMtx functions.
getSeq

Two sequences: starting+ending values from n and blocksize (internal use)
da

internal da
dig

Internal dig
e0

internal e0
comp_portfo2

Compares two vectors (portfolios) using stochastic dominance of orders 1 to 4.
gmcmtx0

Matrix R* of generalized correlation coefficients captures nonlinearities.
gmcxy_np

Function to compute generalized correlation coefficients r*(x|y) and r*(y|x) from two vectors (not matrices)
gmcmtxZ

compute the matrix R* of generalized correlation coefficients.
heurist

Heuristic t test of the difference between two generalized correlations.
goodCol

internal goodCol
exactSdMtx

Exact stochastic dominance computation from areas above ECDF pillars.
generalCorrInfo

generalCorr package description:
i

internal i
ibad

internal object
dif4mtx

order four differencing of a matrix of time series
j

internal j
momentVote

Function compares Pearson Stats and Sharpe Ratio for a matrix of stock returns
mtx

internal mtx
kern2ctrl

Kernel regression with control variables and optional residuals and gradients. version 2 regtype="ll" for local linear, bwmethod="cv.aic" for AIC-based bandwidth selection. It admits control variables.
kern_ctrl

Kernel regression with control variables and optional residuals and gradients.
ii

internal ii
diff.e0

Internal diff.e0
mag

Approximate overall magnitudes of kernel regression partials dx/dy and dy/dx.
mag_ctrl

After removing control variables, magnitude of effect of x on y, and of y on x.
kern2

Kernel regression version 2 with optional residuals and gradients with regtype="ll" for local linear, bwmethod="cv.aic" for AIC-based bandwidth selection.
nall

internal nall
naTriplet

Function to do matched deletion of missing rows from x, y and control variable(s).
mtx0

internal mtx0
nam.badCol

internal nam.badCol
kern

Kernel regression with options for residuals and gradients.
n

internal n
naTriple

Function to do matched deletion of missing rows from x, y and z variable(s).
nam.goodCol

internal nam.goodCol
mtx2

internal mtx2
gmcmtxBlk

Matrix R* of generalized correlation coefficients captures nonlinearities using blocks.
parcorBMany

Block version reports many generalized partial correlation coefficients allowing control variables.
parcorBijk

Block version of generalized partial correlation coefficients between Xi and Xj, after removing the effect of xk, via nonparametric regression residuals.
p1

internal p1
outOFsell

Compare out-of-sample (short) selling algorithms by a leave-percent-out method.
parcorHijk

Generalized partial correlation coefficients between Xi and Xj, after removing the effect of Xk, via OLS regression residuals.
nam.mtx0

internal nam.mtx0
min.e0

internal min.e0
napair

Function to do pairwise deletion of missing rows.
minor

Function to do compute the minor of a matrix defined by row r and column c.
parcorHijk2

Generalized partial correlation coefficients between Xi and Xj,
parcorMany

Report many generalized partial correlation coefficients allowing control variables.
out1

internal out1
parcorMtx

Matrix of generalized partial correlation coefficients, always leaving out control variables, if any.
parcorVecH

Vector of hybrid generalized partial correlation coefficients.
parcor_linear

Partial correlation coefficient between Xi and Xj after removing the linear effect of all others.
parcor_ridg

Compute generalized (ridge-adjusted) partial correlation coefficients from matrix R*. (deprecated)
outOFsamp

Compare out-of-sample portfolio choice algorithms by a leave-percent-out method.
parcorVecH2

Vector of hybrid generalized partial correlation coefficients.
parcor_ijk

Generalized partial correlation coefficients between Xi and Xj, after removing the effect of xk, via nonparametric regression residuals.
parcor_ijkOLD

Generalized partial correlation coefficient between Xi and Xj after removing the effect of all others. (older version, deprecated)
parcorVec

Vector of generalized partial correlation coefficients (GPCC), always leaving out control variables, if any.
parcorSilent

Silently compute generalized (ridge-adjusted) partial correlation coefficients from matrix R*.
rji

internal rji
rijMrji

internal rijMrji
rank2return

Compute the portfolio return knowing the rank of a stock in the input `mtx'.
rank2sell

Compute the portfolio return knowing the rank of a stock in the input `mtx'. This function computes the return earned knowing the rank of a stock computed elsewhere and named myrank associate with the data columns in the input mtx of stock returns. For example, mtx has p=28 Dow Jones stocks over n=169 monthly returns. Portfolio weights are assumed to be linearly declining. If maxChosen=4, the weights are 1/10, 2/10, 3/10 and 4/10, which add up to unity. These portfolio weights are assigned in their order in the sense that first chosen stock (choice rank =p) gets portfolio weight=4/10. The function computes return from the stocks using the `myrank' argument. This helps in assessing out-of-sample performance of (short) the strategy of selling lowest ranking stocks. It is mostly for internal use by outOFsell(). This is a sell version of rank2return().
pcause

Compute the bootstrap probability of correct causal direction.
pillar3D

Create a 3D pillar chart to display (x, y, z) data coordinate surface.
prelec2

Intermediate weighting function giving Non-Expected Utility theory weights.
probSign

Compute probability of positive or negative sign from bootPairs output
rrij

internal rrij
rhs.lag2

internal rhs.lag2
salesLag

internal salesLag
rhs1

internal rhs1
seed

internal seed
rrji

internal rrji
ridgek

internal ridgek
rstar

Function to compute generalized correlation coefficients r*(x,y).
sales2Lag

internal sales2Lag
sgn.e0

internal sgn.e0
rij

internal rij
siPair2Blk

Block Version of silentPair2 for causality scores with control variables
somePairs

Function reporting kernel causality results as a 7-column matrix.(deprecated)
silentMtx0

Older kernel-causality unanimity score matrix with optional control variables
siPairsBlk

Block Version of silentPairs for causality scores with control variables
silentMtx

No-print kernel-causality unanimity score matrix with optional control variables
some0Pairs

Function reporting detailed kernel causality results in a 7-column matrix (uses deprecated criterion 1, no longer recommended but may be useful for second and third criterion typ=2,3)
someCPairs

Kernel causality computations admitting control variables.
someMagPairs

Summary magnitudes after removing control variables in several pairs where dependent variable is fixed.
silentPairs0

Older version, kernel causality weighted sum allowing control variables
someCPairs2

Kernel causality computations admitting control variables reporting a 7-column matrix, version 2.
silentPairs

No-print kernel causality scores with control variables Hausman-Wu Criterion 1
silentPair2

kernel causality (version 2) scores with control variables
somePairs2

Function reporting kernel causality results as a 7-column matrix, version 2.
sort.e0

internal sort.e0
sort.abse0

internal sort.abse0
sudoCoefParcor

Pseudo regression coefficients from generalized partial correlation coefficients, (GPCC).
sudoCoefParcorH

Peudo regression coefficients from hybrid generalized partial correlation coefficients (HGPCC).
summaryRank

Compute ranks of rows of matrix and summarize them into a choice suggestion.
wtdpapb

Creates input for the stochastic dominance function stochdom2
symmze

Replace asymmetric matrix by max of abs values of [i,j] or [j,i] elements.
sort_matrix

Sort all columns of matrix x with respect to the j-th column.
stdres

Residuals of kernel regressions of x on y when both x and y are standardized.
stdz_xy

Standardize x and y vectors to achieve zero mean and unit variance.
stochdom2

Compute vectors measuring stochastic dominance of four orders.
GcRsqYX

Nonlinear Granger causality between two time series workhorse function.
GcRsqX12c

Generalized Granger-Causality. If dif>0, x2 Granger-causes x1.
GcRsqYXc

Nonlinear Granger causality between two time series workhorse function.(local constant version)
EuroCrime

European Crime Data
GcRsqX12

Generalized Granger-Causality. If dif>0, x2 Granger-causes x1.
Panel2Lag

Function to compute a vector of 2 lagged values of a variable from panel data.
NLhat

Compute fitted values from kernel regression of x on y and y on x
PanelLag

Function for computing a vector of one-lagged values of xj, a variable from panel data.
absBstdrhserC

Block version abs_stdrhser Absolute residuals kernel regressions of standardized x on y and control variables, Cr1 has abs(Resid*RHS).
allPairs

Report causal identification for all pairs of variables in a matrix (deprecated function). It is better to choose a target variable and pair it with all others, instead of considering all possible targets.
badCol

internal badCol
abs_stdapd

Absolute values of gradients (apd's) of kernel regressions of x on y when both x and y are standardized.
abs_res

Absolute residuals of kernel regression of x on y.
absBstdresC

Block version of Absolute values of residuals of kernel regressions of standardized x on standardized y and control variables.
absBstdres

Block version of abs-stdres Absolute values of residuals of kernel regressions of standardized x on standardized y, no control variables.
abs_stdresC

Absolute values of residuals of kernel regressions of x on y when both x and y are standardized and control variables are present (C for control presence).
abs_stdres

Absolute values of residuals of kernel regressions of x on y when both x and y are standardized.