build_gnaf: Builds G-NAF into a flat 'data.table' object.
In KyleHaynes/gnaf.r: Import the (Australian) Geocoded - National Address File (G-NAF) in to R.

build_gnaf

R Documentation

Builds G-NAF into a flat `data.table` object.

Description

Builds G-NAF into a flat data.table object.

Usage

build_gnaf(
  setup = gnaf_setup_data,
  simple = FALSE,
  drop_empty_vars = TRUE,
  drop_date_variables = TRUE,
  missing = "",
  concatenate = TRUE,
  add_geo_coordinate = TRUE,
  add_meshblock_years = NULL,
  add_locality_alias_variants = FALSE,
  add_alias_links = FALSE,
  verbose = TRUE
)

Arguments

`setup`	defining the default `gnaf_setup_data` object.
`simple`	A logical argument to remove (potentially) unused, technical fields. Default is `FALSE`.
`drop_empty_vars`	A logical argument to remove empty fields. Default is `TRUE`.
`drop_date_variables`	A logical argument to remove date (creation / retire / modification) fields. Default is `TRUE`.
`missing`	A character or NA to determine what empty (missing) observations should be. Default is `""`.
`concatenate`	A logical argument to add determine if a full address string should be constructed. Default is `TRUE`.
`add_geo_coordinate`	A logical argument to add geographical coordinate latitude and longitude fields. Default is `TRUE`.
`add_meshblock_years`	A character string specifying which meshblock years to add. Default is `FALSE`. Depending on what version of G-NAF you have sourced `c("2021", "2016", "2011")`.
`add_locality_alias_variants`	A logical argument to include locality alias variants. Default is `FALSE`.
`add_alias_links`	A logical argument to allow inclusion of primary id on alias addresses. Default is `FALSE`.
`verbose`	A logical argument to verbose. Default is `TRUE`.