as_cov_names: Re-label alternative specific covariates

View source: R/as_cov_names.R

as_cov_namesR Documentation

Re-label alternative specific covariates

Description

In {RprobitB}, alternative specific covariates must be named in the format "<covariate>_<alternative>". This helper function generates the format for a given choice_data set.

Usage

as_cov_names(choice_data, cov, alternatives)

Arguments

choice_data

[data.frame]
Choice data in wide format, where each row represents one choice occasion.

cov

[character()]
Names of alternative specific covariates in choice_data.

alternatives

[atomic()]
The alternative names.

Value

The choice_data input with updated column names.

Examples

data("Electricity", package = "mlogit")
cov <- c("pf", "cl", "loc", "wk", "tod", "seas")
alternatives <- 1:4
colnames(Electricity)
Electricity <- as_cov_names(Electricity, cov, alternatives)
colnames(Electricity)


RprobitB documentation built on Aug. 26, 2025, 1:08 a.m.