Harmonise column names in a multi-year ATO panel

ATO renames columns across annual releases; a stacked panel from ato_individuals_postcode(year = c("2020-21", "2021-22")) may have inconsistent names like total_income vs total_income_or_loss. ato_harmonise() renames columns to the first variant in ATO_COL_VARIANTS so panels are join-ready.

Usage

ato_harmonise(df)

Arguments

df

A data frame (typically an ato_tbl with year column from a multi-year call).

Value

A data frame with harmonised names. ato_tbl class and provenance attributes are preserved.

Details

Unknown columns are left alone. Columns that collide after renaming (because two variants map to the same canonical name) emit a warning; the first column wins.

See also

Other harmonisation: ato_crosswalk(), ato_deflate(), ato_per_capita(), ato_reconcile(), ato_schema_map(), ato_to_taxstats()

Examples

df <- data.frame(postcode = "2000",
                 total_income_or_loss = 100,
                 state_territory = "NSW")
ato_harmonise(df)
#>   postcode total_income_or_loss state
#> 1     2000                  100   NSW