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

    Interface HTest

    Result of a hypothesis test: a plain object mirroring R's htest class.

    R's named values (statistic, parameter, estimate, null.value) are split into a number and a separate ...Name field. estimate is an array only when there are two estimates (for example the two means of a two-sample t-test). conf.int's conf.level attribute becomes confLevel.

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

    Hierarchy (View Summary)

    Index
    alternative confInt? confLevel? estimate? estimateNames? method nullValue? nullValueName? parameter? parameterName? pValue statistic statisticName warnings
    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 | number[]

    Estimate(s) of the parameter being tested (R's estimate).

    estimateNames?: string | string[]

    Name(s) of estimate (R's names(estimate)), e.g. "mean of x".

    method: string

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

    nullValue?: number

    Value of the parameter under the null hypothesis (R's null.value).

    nullValueName?: string

    Name of nullValue (R's names(null.value)), e.g. "difference in means".

    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).

    Settings
    Member Visibility

    On This Page
    Properties