check_form: Check 'form'.

Description Usage Arguments Value

View source: R/check_form.R

Description

This function checks the input form.

Usage

1
check_form(form, re = NULL)

Arguments

form

A formula object that is used to specify the probit model. The structure is choice ~ A | B | C, where

  • A are names of alternative and choice situation specific covariates with a generic coefficient,

  • B are names of choice situation specific covariates with alternative specific coefficients,

  • and C are names of alternative and choice situation specific covariates with alternative specific coefficients.

Separate multiple covariates of one type by a + sign. By default, alternative specific constants (ASCs) are added to the model (for all except for the last alternative). They can be removed by adding +0 in the second spot. See the vignette vignette("data_management", package = "RprobitB") for more details.

re

A character (vector) of covariates of form with random effects. If re = NULL (the default), there are no random effects. To have random effects for the alternative specific constants, include "ASC" in re.

Value


RprobitB documentation built on Nov. 12, 2021, 5:08 p.m.