MHQoL (version 0.14.0)

mhqol: A function to calculate the utility of the MHQoL

Description

This function calculates the utility of the MHQoL based on the scores of the different dimensions.

Usage

mhqol(
  dimensions,
  country = "Netherlands",
  metric = c("average", "total"),
  ignore_invalid = FALSE,
  ignore_NA = FALSE)

Value

A dataframe containing the utilities based on the MHQoL valuesets

Arguments

dimensions

A dataframe, character vector, numeric vector, or list containing the dimensions of the MHQoL. Must contain the following dimensions: SI (Self-Image), IN (INdependence), MO (MOod), RE (RElationships), DA (Daily Activities), PH (Physical Health), FU (FUture).

country

A character value indicating the country for which the utilities should be calculated. Standard is the Netherlands

metric

A character value indicating whether to calculate the "total" or "average" utility.

ignore_invalid

If TRUE, the function will ignore missing dimensions and continue processing. If FALSE, the function will stop and throw an error.

ignore_NA

If TRUE, the function will ignore NA values in the input data. If FALSE, the function will stop and throw an error.

Examples

# Example usage of the mhqol_utilities function

# Get the utility based on a numeric vector and calculate the total utility,
# not all dimensions and values are present
mhqol(
  dimensions = c(IN = 2, MO = 3, RE = 2, DA = NA, PH = 2, FU = 3),
  metric = "total",
  ignore_invalid = TRUE,
  ignore_NA = TRUE
  )

# Get the utility based on a dataframe and calculate the average utility
mhqol(
  dimensions = data.frame(SI = 1, IN = 2, MO = 3, RE = 2, DA = 1, PH = 2, FU = 3),
  metric = "average"
  )