Skip to content

Amend Names in a Data Frame Column

Source: R/amend_names.R
amend_names.Rd

Standardises names in a specified column of a data frame based on predefined conversion mappings. Currently supports converting Australian state names to abbreviations and vice versa. The conversion mappings are sourced from the internal name_conversions dataset within the scgElectionsAU package. Matching is performed case-insensitively to accommodate variations like "TAS" vs "Tas" or "Victoria" vs "VICTORIA".

Usage

amend_names(
  data,
  column_name,
  conversion_type = c("state_to_abbr", "abbr_to_state")
)

Arguments

data

A data frame containing the column to be amended.

column_name

A character string specifying the name of the column in data to amend.

conversion_type

A character string specifying the type of conversion to perform. Must be one of: "state_to_abbr" (converts state names to abbreviations) or "abbr_to_state" (converts abbreviations to state names). Defaults to "state_to_abbr".

Value

A data frame identical to data, with the specified column_name amended according to the chosen conversion_type. Unmatched values remain unchanged. The output retains the original case of the standardised values as defined in the name_conversions dataset.

Details

This function relies on the internal name_conversions dataset, which contains mappings for standardising names. It uses a lookup table approach to replace original values with their standardised equivalents. Matching is case-insensitive, achieved by converting both the input column and the conversion table's original values to uppercase during comparison. If a value in the specified column does not match any original value in the conversion table (ignoring case), it is preserved as-is.

Examples

# Sample data frame with mixed case
df <- data.frame(
  state = c("NEW SOUTH WALES", "victoria", "Unknown"),
  value = c(10, 20, 30)
)

# Convert state names to abbreviations
amend_names(df, "state", "state_to_abbr")
#>     state value
#> 1     NSW    10
#> 2     VIC    20
#> 3 Unknown    30

# Convert abbreviations with mixed case
df_abbr <- data.frame(
  state = c("nsw", "Vic", "tas"),
  value = c(10, 20, 30)
)
amend_names(df_abbr, "state", "abbr_to_state")
#>             state value
#> 1 New South Wales    10
#> 2        Victoria    20
#> 3        Tasmania    30