External module "stats/pcorrtest/docs/types/index.d"

Export assignment pcorrTest

• pcorrTest(x: NumericArray, y: NumericArray, options?: Options): Results

• Computes a Pearson product-moment correlation test between paired samples.

  Notes

  • By default, the function performs a t-test for the null hypothesis that the data in arrays or typed arrays x and y is not correlated. A test against a different population correlation can be carried out by supplying the rho option. In this case, a test using the Fisher's z transform is conducted.
  • The returned object comes with a .print() method which when invoked will print a formatted output of the results of the hypothesis test.

  throws

  x and y must be arrays of the same length

  throws

  x and y must contain at least four elements

  throws

  must provide valid options

  Parameters

  • x: NumericArray

    first data array

  • y: NumericArray

    second data array

  • Optional options: Options

    function options

  Returns Results

  test result object

  Example

  var x = [ 2, 4, 3, 1, 2, 3 ];
  var y = [ 3, 2, 4, 1, 2, 4 ];
  var out = pcorrTest( x, y );