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

    Interface LmerPredictOptions

    Options of lmerPredict. Only the keys below are accepted: R's re.form, allow.new.levels, random.only, se.fit, newparams, terms, na.action and naAction give the Error lmerPredict: argument '<key>' is not supported, any other key a RangeError.

    interface LmerPredictOptions {
        allowNewLevels?: boolean;
        newdata?: DataFrame;
        randomOnly?: boolean;
        reForm?: string | false | null;
        seFit?: boolean;
        type?: "response" | "link";
    }

    Hierarchy (View Summary)

    Index
    allowNewLevels?: boolean

    Whether a level of a grouping factor not in the fit, or a missing grouping value, is allowed (default false, an error): that term then adds 0 for the row (the population level for that term). R's allow.new.levels.

    newdata?: DataFrame

    The rows to predict: a data frame with the columns of the fit's data that the prediction uses (the variables of the fixed-effects part and of the selected random-effects terms; not the response). Default: the rows of the fit.

    randomOnly?: boolean

    Whether to predict the random part only, without the fixed effects and the offset (default false; R's random.only).

    reForm?: string | false | null

    Which random-effects terms to include (R's re.form): undefined or null all of them (default); false, "~0" or "~ 0" none (the population-level prediction); a one-sided formula such as "~ (1 | g)" those written in it (its fixed part is ignored). Its grouping factors must be the fit's and its columns among the fit's columns for that factor; a term may have fewer columns than the fit's.

    seFit?: boolean

    Whether to return the standard errors (default false; R's se.fit).

    type?: "response" | "link"

    "link" (default) or "response": for lmer both give the same values, as in R.