rStats.js v1.3.0
    Preparing search index...

    Interface CorTestResult

    Result of corTest. For Pearson, statisticName is "t" with parameter (df) and confInt; for Kendall "T" (exact) or "z"; for Spearman "S".

    interface CorTestResult {
        alternative: Alternative;
        confInt?: [number, number];
        confLevel?: number;
        estimate: number;
        estimateNames: string;
        method: string;
        nullValue: number;
        nullValueName: string;
        parameter?: number;
        parameterName?: string;
        pValue: number;
        statistic: number;
        statisticName: string;
        warnings: string[];
    }

    Hierarchy (View Summary)

    Index
    alternative: Alternative

    Alternative hypothesis, always in full form.

    confInt?: [number, number]

    Confidence interval [lower, upper] (R's conf.int).

    confLevel?: number

    Confidence level of confInt (R's attr(conf.int, "conf.level")).

    estimate: number

    Sample correlation coefficient.

    estimateNames: string

    "cor", "tau" or "rho".

    method: string

    Description of the test, as R's method (e.g. "Welch Two Sample t-test").

    nullValue: number

    Correlation under the null hypothesis: always 0.

    nullValueName: string

    "correlation", "tau" or "rho".

    parameter?: number

    Parameter of the null distribution of the statistic, such as degrees of freedom (R's parameter).

    parameterName?: string

    Name of parameter (e.g. "df").

    pValue: number

    p-value of the test (R's p.value).

    statistic: number

    Value of the test statistic (R's statistic).

    statisticName: string

    Name of the test statistic (e.g. "t", "X-squared", "V", "W").

    warnings: string[]

    R's warnings, each once, in R's order (an empty array when there are none).