correlation {RGeoS}R Documentation

Plot the translated correlation

Description

Plot the translated correlation, for one or two variables

Usage

correlation(db, icol1=1, icol2=NA, ndisc=100,
		flag.same=TRUE, flag.regr=FALSE, flag.iso=FALSE, flag.diag=FALSE, 
		dmin=NA, dmax=NA, dirvect = NA, tol = NA, opt.code = 0, 
		tolcode = 0, mini1=NA, maxi1=NA, mini2=NA, maxi2=NA,  ...)

Arguments

db

The db-class containing the data information used to calculate the correlation.

icol1

Rank of the column containing the first target variable

icol2

Rank of the column containing the second target variable

ndisc

Number of discretization steps along each axis for graphic representation

flag.same

TRUE if the variables must be compared at the same location (standard correlation). FALSE for the shifted correlation

flag.regr

When TRUE, represent the regression line of the variable 'icol2' as a function of the variable 'icol1'

flag.iso

When TRUE, the axes are the same, calculated from the minimum of both variables to the maximum of both variables.

flag.diag

When TRUE, represent the diagonal between the lower left and the upper right corners

dmin

Minimum distance for the calculation of the translated correlation

dmax

Maximum distance for the calculation of the translated correlation

dirvect

The directions in which the translated correlation must be calculated. For more information, refer to get.directions

tol

Angular tolerance. If no angular tolerance is not defined, the tolerance is set to 90 degrees.

opt.code

Option concerning the sample codes for constituting pairs:

  • 0 : a pair of samples is selected whatever their codes (if active)

  • 1 : a pair is retained if the code is active in the data base and the codes of the two samples are closer than tolcode

  • 2 : a pair is retained only if the codes of the two samples are different

tolcode

Maximum distance between the codes of the two samples.

mini1

Minimum value for the first target variable

maxi1

Maximum value for the first target variable

mini2

Minimum value for the second target variable

maxi2

Maximum value for the second target variable

...

Parameters transmitted to the plot function.

Details

When one variable is provided, the function calculates: Correl(Z1(x),Z1(x+h)) For two variables, the function calculates: Correl(Z1(x),Z2(x+h))


[Package RGeoS version 9.1.1 Index]