
Tidy a dirty table's column names and category labels before masking
Source:R/clean_table.R
clean_table.RdReal custodian tables arrive with column names that are not valid R
names ("Yield (t/ha)", "Site Name"), leading or trailing
whitespace in names and factor / character values, and the
occasional near-duplicate label ("north" vs "North" vs
" north"). clean_table() legalises names and trims whitespace, and
reports each fix. Near-duplicate labels are only reported, since merging
labels that look alike is a judgement call; conform_table() makes it.
Usage
clean_table(df, clean = c("auto", "report", "off"), quiet = FALSE)Arguments
- df
A data frame.
- clean
One of
"auto"(default - legalise names, trim whitespace, report near-duplicates),"report"(legalise names, report what whitespace / near-duplicate changes would be made but apply none), or"off"(legalise names only, skip all other hygiene). Column-name legalisation is applied in every mode – an invalid name silently rewritten downstream corrupts the clone – and is surfaced as amasque_name_repairedwarning; only the whitespace and near-duplicate handling is governed by the mode.- quiet
Logical. When
FALSE(default) aclisummary of the fixes and advisories is printed. SetTRUEto suppress it (the report object is returned either way).
Value
An object of class masque_cleaning: a list with
data- the cleaned (or, underreport/off, unchanged) data.table;name_map- named characteroriginal -> cleanfor every column whose name changed (empty if none);level_fixes- named list, one entry per column whose values were trimmed, each a named characteroriginal -> clean;near_duplicates- a data.table of report-only label pairs (col,a,b,kind) that look like typos but were left untouched. Labels that differ only inside a run of digits ("G01"and"G02","Plot12"and"Plot13") are different codes and are not listed. The printed report shows the first 20 pairs and the count, and a recipe keeps the same;mode- thecleanmode applied.
Details
The corrections are returned alongside the cleaned data, so mask()
records them in the recipe and apply_recipe() re-applies the same
cleaning to the original.
Two input columns with the same name are refused with a
masque_duplicate_names_refusal error: the recipe records renamed
columns by their original name, so the two could not be told apart on
the round trip. Rename them first.
Examples
df <- data.frame(
`Site Name` = c("north ", "north", "South"),
`Yield (t/ha)` = c(3.1, 2.9, 5.0),
check.names = FALSE
)
cl <- clean_table(df, quiet = TRUE)
#> Warning: Renamed 2 column names that R does not accept: `Site Name` -> `Site.Name`, `Yield (t/ha)` -> `Yield..t.ha.`. The map is recorded in the recipe and reversed on the round-trip.
names(cl$data)
#> [1] "Site.Name" "Yield..t.ha."
cl$near_duplicates
#> Empty data.table (0 rows and 4 cols): col,a,b,kind