get_abs_household_size_distribution: Get household size distribution based on state or LGA name
In njtierney/conmat: Builds Contact Matrices using GAMs and Population Data

View source: R/get_household_size_distribution.R

get_abs_household_size_distribution

R Documentation

Get household size distribution based on state or LGA name

Description

Get household size distribution based on state or LGA name

Usage

get_abs_household_size_distribution(state = NULL, lga = NULL)

Arguments

`state`	target Australian state name in abbreviated form, such as "QLD", "NSW", or "TAS"
`lga`	target Australian local government area (LGA) name, such as "Fairfield (C)". See `abs_lga_lookup()` for list of lga names

Value

returns a data frame with household size distributions of a specific state or LGA

Examples

get_abs_household_size_distribution(lga = "Fairfield (C)")
get_abs_household_size_distribution(state = "NSW")
## Not run: 
# cannot specify both state and LGA
get_abs_household_size_distribution(state = "NSW", lga = "Fairfield (C)")

## End(Not run)

njtierney/conmat documentation built on April 17, 2025, 10:27 p.m.