per_capita_household_size: Get per capita household size with household size...

In njtierney/conmat: Builds Contact Matrices using GAMs and Population Data

Get per capita household size with household size distribution

Description

Returns the per capita household size for a location given its household size distribution. See get_abs_household_size_distribution() function for retrieving household size distributions for a given place.

Usage

per_capita_household_size(
  household_data,
  household_size_col = household_size,
  n_people_col = n_people
)

Arguments

household_data	data set with information on the household size distribution of specific state or LGA.
household_size_col	bare variable name of the column depicting the household size. Default is 'household_size' from get_abs_per_capita_household_size_lga().
n_people_col	bare variable name of the column depicting the total number of people belonging to the respective household size. Default is 'n_people' from get_abs_per_capita_household_size_lga().

Value

Numeric of length 1 - the per capita household size for a given state or LGA.

Author(s)

Nick Golding

Examples

demo_data <- get_abs_household_size_population(lga = "Fairfield (C)")
demo_data
per_capita_household_size(
  household_data = demo_data,
  household_size_col = household_size,
  n_people_col = n_people
)

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