Skip to contents

Define choice preferences

Source: R/choice_preferences.R
choice_preferences.Rd

The choice_preferences object defines the deciders' preferences in the choice model.

  • choice_preferences() constructs a choice_preferences object.

  • generate_choice_preferences() samples choice preferences at random.

Usage

choice_preferences(data_frame, column_decider = "deciderID")

generate_choice_preferences(
  choice_effects,
  choice_parameters = generate_choice_parameters(choice_effects),
  choice_identifiers = generate_choice_identifiers(N = 100)
)

Arguments

data_frame

[data.frame]
Contains the deciders' preferences.

column_decider

[character(1) | NULL]
The column name of data_frame with the decider identifiers. If NULL, decider identifiers are generated.

choice_effects

[choice_effects]
A choice_effects object.

choice_parameters

[choice_parameters]
A choice_parameters object.

choice_identifiers

[choice_identifiers]
A choice_identifiers object.

Value

An object of class choice_preferences, which is a tibble with the deciders' preferences. The column names are the names of the effects in the choice model. The first column contains the decider identifiers, its name is stored in the attribute column_decider.

Examples

### generate choice preferences from choice parameters and effects
set.seed(1)
choice_effects <- choice_effects(
  choice_formula = choice_formula(
    formula = choice ~ price | income | comfort,
    error_term = "probit",
    random_effects = c(
      "price" = "cn",
      "income" = "cn"
    )
  ),
  choice_alternatives = choice_alternatives(J = 3)
)
choice_parameters <- generate_choice_parameters(
  choice_effects = choice_effects, C = 2
)
(choice_preferences <- generate_choice_preferences(
  choice_parameters = choice_parameters,
  choice_effects = choice_effects,
  choice_identifiers = generate_choice_identifiers(N = 4)
))
#> # A tibble: 4 × 9
#>   deciderID ASC_B  ASC_C comfort_A comfort_B comfort_C price income_B income_C
#> * <chr>     <dbl>  <dbl>     <dbl>     <dbl>     <dbl> <dbl>    <dbl>    <dbl>
#> 1 1         -1.98  0.581     -2.64      5.04      1.04 -1.92     1.59    2.71 
#> 2 2          1.82 -0.966      4.78      1.23     -1.96 -8.04     3.34   -1.35 
#> 3 3         -1.98  0.581     -2.64      5.04      1.04 -2.78     2.23    3.10 
#> 4 4          1.82 -0.966      4.78      1.23     -1.96 -9.44     3.21    0.438