pcor: Parallel Correlation

Description Usage Arguments Value Author(s) See Also

View source: R/pcor.R

Description

Parallel Pearson's correlation. It either takes a 2D array as input and correlates each row with every other row or takes two 2D arrays and correlates the columns of the first matrix with the columns of the second matrix. The output can either be the matrix of correlation coefficient or the distance matrix.

N.B. Please see the SPRINT User Guide for how to run the code in parallel using the mpiexec command.

Usage

1
2
pcor(data_x, data_y = NULL, distance = FALSE, caching_ = "mmeachflush", 
     filename_ = NULL)

Arguments

data_x

double precision 2D array of data

data_y

NULL or second double precision 2D array of data

distance

boolean, whether the distance or correlation coefficient matrix is returned

caching_

string, either "mmeachflush" or "mmnoflush" select the back-end caching scheme

filename_

string, name of the result file

Value

An ff_matrix object. The results of a correlation computation can be very large and so SPRINT returns a file-backed ff_matrix object instead of a standard R matrix object.

Author(s)

University of Edinburgh SPRINT Team [email protected] www.r-sprint.org

See Also

cor SPRINT ff


sprint documentation built on May 30, 2017, 8:25 a.m.