Package index • fplida

Build a dataset

The usual entry points.

build_fplida(): Build a complete fplida dataset using parallel slice workers
generate_spine(): Generate the synthetic person spine

Look up the metadata

What a dataset holds, and what every variable means. These read the bundled registries and need no generated data.

reexports dataset_info variable_info variable_values get_values get_mbs_item_numbers get_pbs_item_codes get_mesh_blocks get_sa1_codes get_sa2_codes get_country_codes: Objects exported from other packages
plida_dataset_years(): Years a PLIDA dataset covers
plida_dataset_periods(): Reference periods of every PLIDA dataset

Nominal growth

Generated dollar amounts are nominal, so they carry the price and wage level of their reference year. These expose the published series that put them there, for deflating output or for checking what it was indexed to.

nominal_index(): Published nominal indices used to generate fplida dollar amounts
nominal_indices(): The full table of nominal indices, with provenance

Output location

set_data_path(): Set the fplida data output directory
get_data_path(): Get the fplida data output directory
fplida_version(): Return the package version string.

Generators

One per PLIDA dataset, plus the BLADE module. Each projects its products from the shared person or business spine. Call build_fplida() instead unless you want a single dataset.

generate_acld(): Generate ACLD dataset (Australian Census Longitudinal Dataset)
generate_aedc(): Generate AEDC dataset (Australian Early Development Census)
generate_air(): Generate AIR dataset (Australian Immunisation Register)
generate_amep(): Generate AMEP dataset (Adult Migrant English Program)
generate_apprentice(): Generate A&T dataset (Apprentice and Trainee)
generate_ato_cr(): Generate ATO_CR dataset (ATO Client Register)
generate_births(): Generate BIRTHS dataset (Birth Registrations)
generate_blade(): Generate BLADE business-level DIL tables
generate_blade_business_spine(): Generate the BLADE business source-of-truth spine
generate_busown(): Generate BUSOWN dataset (Business Ownership)
generate_census(): Generate simulated 2021 Census data
generate_cgt(): Generate CGT dataset (Capital Gains Tax)
generate_combined(): Generate COMBINED dataset (Combined Demographics – Indigenous Status)
generate_core(): Generate CORE dataset (Demographics, Locations, Relationships, Core Scope)
generate_deaths(): Generate DEATHS dataset (Death Registrations)
generate_dex(): Generate DEX dataset (Data Exchange)
generate_apsed() generate_ato_mcs() generate_ers() generate_jk() generate_jm() generate_nhs() generate_nsmhw() generate_pex() generate_smsf(): Generate nine PLIDA datasets
generate_domino(): Generate DOMINO dataset (Centrelink Administrative Data)
generate_employment_panel(): Generate longitudinal employment panel from spine
generate_he(): Generate Higher Education (HE) dataset
generate_lfs(): Generate Longitudinal Labour Force Survey data
generate_mbs(): Generate MBS dataset (Medicare Benefits Schedule Claims)
generate_mcd(): Generate MCD dataset (Medicare Consumer Directory)
generate_mt_demogs(): Generate MT_DEMOGS dataset (Migrant and Traveller Demographics)
generate_nacdc(): Generate NACDC dataset (National Aged Care Data Clearinghouse)
generate_ndis(): Generate NDIS dataset (National Disability Insurance Scheme)
generate_pbs(): Generate PBS dataset (Pharmaceutical Benefits Scheme Dispensings)
generate_pit_ie(): Generate ABS Derived Income data (PIT_IE)
generate_pit_itr(): Generate ATO Income Tax Return data (PIT_ITR)
generate_pit_ps(): Generate ATO Payment Summary data (PIT_PS)
generate_rps(): Generate RPS dataset (Rental Property Schedule)
generate_sae(): Generate SAE dataset (Superannuation Accounts Extract)
generate_sdac(): Generate SDAC dataset (Survey of Disability, Ageing and Carers)
generate_sdb(): Generate SDB dataset (Settlements Database)
generate_stp(): Generate STP dataset (Single Touch Payroll)
generate_travellers(): Generate TRAVELLERS dataset (Traveller Movements)
generate_tva(): Generate TVA dataset (Total VET Activity)
generate_visa(): Generate VISA dataset (Visa Applications and Grants)

Output and linkage utilities

convert_parquet_dir_to_csv(): Convert a parquet fplida run directory to CSV via DuckDB
write_agency_spine(): Write an agency spine file
build_spine_template(): Build (or rebuild) the spine template for a given seed
build_fplida_slice_worker(): Run the fplida product pipeline inside a single slice worker
census_household_roles(): Each person's relationship to their household
write_census_household_roles(): Compute the household roles once for a whole build