oxcgrt (version 0.1.0)

calculate_subindex: Calculate OxCGRT sub-index score for a single indicator

Description

Calculate OxCGRT sub-index score for a single indicator

Calculate OxCGRT sub-index scores for all indicators

Usage

calculate_subindex(indicator_code, value, flag_value)
calculate_subindices(
  df,
  indicator_code = "policy_type_code",
  value = "policyvalue_actual",
  flag_value = "flagged",
  add = TRUE
)

Arguments

indicator_code

A character value specifying the name of the variable in df containing the policy type codes. By default, this is set to policy_type_code which is the variable name used by the OxCGRT API.

value

A character value specifying the name of the column in df containing the values in ordinal scale assigned to each policy type. By default, this is set to policyvalue_actual which is the variable name used by the OxCGRT API.

flag_value

A character value specifying the name of the column in df containing the flag values for each policy type. By default, this is set to flagged which is the variable name used by the OxCGRT API.

df

A data.frame containing per indicator values required for calculating sub-index scores. This data.frame will be structured similarly as the policy actions data.frame produced by a call to get_data_actions().

add

Logical. Should sub-indices for each indicator be added to df? Default is TRUE.

Value

A numeric value between 0 to 100.

If add is TRUE (default), returns a tibble composed of the input data.frame x with an added column named score for the calculated sub-indices. If add is FALSE, returns a tibble of 4 columns with the first column for the policy codes named policy_type_codes, the second column for the policy values named policy_value, the third column for the flag values named flag_value and the fourth column named score for the calculated sub-indices.

Examples

# NOT RUN {
calculate_subindex(indicator_code = indicatorData$indicator[1],
                   value = indicatorData$value[1],
                   flag_value = indicatorData$flag_value[1])

x <- get_data(json = get_json_actions(ccode = "AFG",
                                      from = NULL,
                                      to = "2020-09-01"))
calculate_subindices(df = x$policyActions)

# }