eq5dsuite (version 1.0.1)

eqvs_add: eqvs_add

Description

Add user-defined EQ-5D value set and corresponding crosswalk option.

Usage

eqvs_add(
  df,
  version = "5L",
  country = NULL,
  countryCode = NULL,
  VSCode = NULL,
  description = NULL,
  saveOption = 1,
  savePath = NULL
)

Value

True/False, indicating success or error.

Arguments

df

A data.frame or file name pointing to csv file. The contents of the data.frame or csv file should be exactly two columns: state, containing a list of all 3125 (for 5L) or 243 (for 3L) EQ-5D health state vectors, and a column of corresponding utility values, with a suitable name.

version

Version of the EQ-5D instrument. Can take values 5L (default) or 3L.

country

Optional string. If not NULL, will be used as a country description for the user-defined value set.

countryCode

Optional string. If not NULL, will be used as the two-digit code for the value set. Must be different from any existing national value set code.

VSCode

Optional string. If not NULL, will be used as the three-digit code for the value set. Must be different from any existing national value set code.

description

Optional string. If not NULL, will be used as a descriptive text for the user-defined value set.

saveOption

Integer indicating how the cache data should be saved. 1: Do not save (default), 2: Save in package folder, 3: Save in another path.

savePath

A path where the cache data should be saved when `saveOption` is 3. Please use `eqvs_load` to load it in your next session.

Examples

# make nonsense value set
new_df <- data.frame(state = make_all_EQ_indexes(), TEST = runif(3125))
# Add as value set for Fantasia
eqvs_add(
   new_df,
   version = "5L",
   country = 'Fantasia',
   countryCode = "MyCountry",
   VSCode = "FAN",
   saveOption = 1
)
eq5d5l(55555,country = "FAN")