create_labels_Sigma: Create labels for 'Sigma'

View source: R/model_evaluation.R

create_labels_SigmaR Documentation

Create labels for Sigma

Description

This function creates labels for the model parameter Sigma.

Usage

create_labels_Sigma(J, cov_sym, ordered = FALSE)

Arguments

J

The number (greater or equal 2) of choice alternatives.

cov_sym

Set to TRUE for labels of symmetric covariance elements.

ordered

A boolean, FALSE per default. If TRUE, the choice set alternatives is assumed to be ordered from worst to best.

Details

The labels are of the form "j1,j2", where j1,j2 are indices of the two alternatives j1 and j2.

Value

A vector of labels for the model parameter Sigma of length (J-1)^2 if cov_sym = TRUE or of length J*(J-1)/2 if cov_sym = FALSE. If ordered = TRUE, Sigma has only one element.

Examples

RprobitB:::create_labels_Sigma(3, cov_sym = TRUE)
RprobitB:::create_labels_Sigma(4, cov_sym = FALSE)
RprobitB:::create_labels_Sigma(4, ordered = TRUE)

RprobitB documentation built on Nov. 10, 2022, 5:12 p.m.