Documentation

pearsonr() function

pearsonr() returns the covariance of two streams of tables normalized to the Pearson R coefficient.

Function type signature
(on: [string], x: A, y: B) => stream[C] where C: Record

For more information, see Function type signatures.

Parameters

x

(Required) First input stream.

y

(Required) Second input stream.

on

(Required) List of columns to join on.

Examples

Return the covariance between two streams of tables

import "generate"

stream1 =
    generate.from(
        count: 5,
        fn: (n) => n * n,
        start: 2021-01-01T00:00:00Z,
        stop: 2021-01-01T00:01:00Z,
    )
        |> toFloat()

stream2 =
    generate.from(
        count: 5,
        fn: (n) => n * n * n / 2,
        start: 2021-01-01T00:00:00Z,
        stop: 2021-01-01T00:01:00Z,
    )
        |> toFloat()

pearsonr(x: stream1, y: stream2, on: ["_time"])

View example output


Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more