cor-ml.col.def-ml.col.def-method: Correlation

In rfml: MarkLogic NoSQL Database Server in-Database Analytics for R

Description

Returns the Pearson correlation coefficient between two ml.data.frame fields.

Usage

## S4 method for signature 'ml.col.def,ml.col.def'
cor(x, y = NULL, use = NULL,
  method = NULL)

Arguments

x	a ml.data.frame field.
y	a ml.data.frame field
use	not used currently
method	not used currently

Details

The function eliminates all pairs for which either the first element or the second element is empty. After the elimination, if the length of the input is less than 2, the function returns the empty sequence. After the elimination, if the standard deviation of the first column or the standard deviation of the second column is 0, the function returns the empty sequence.

Value

The correlation coefficient

Examples

## Not run: 
 library(rfml)
 locConn <- ml.connect()
 # create a ml.data.frame based on a search
 mlIris <- ml.data.frame(locConn, collection = "iris")
 # return the correlation
 cor(mlIris$Sepal.Length, mlIris$Petal.Length)

## End(Not run)

rfml documentation built on May 2, 2019, 3:01 a.m.