Generate TRAVELLERS dataset (Traveller Movements)

Usage

generate_travellers(
  spine = NULL,
  seed = 42L,
  years = 2006L:2024L,
  output_dir = NULL,
  format = c("parquet", "csv"),
  return_data = FALSE
)

Arguments

spine: Data.frame from generate_spine() or NULL. If NULL, the spine is loaded from the active run directory.
seed: Integer. Random seed.
years: Integer vector. Traveller movement years to generate.
output_dir: Character or NULL. Base output directory. If NULL, uses get_data_path().
format: Character. Currently parquet only. Passing "csv" is accepted by the argument matcher but rejected at runtime.
return_data: Logical. If TRUE, returns generated data.frames in addition to writing parquet.

Dataset and variable information

The Home Affairs overseas movements website gives information about this dataset. Use dataset_info("TRAVELLERS") for dataset information. Use variable_info("TRAVELLERS") for variables, sources, value support, and topic tags.