get_seifa_index_sheet: Parse SEIFA index Spreadsheet

In runapp-aus/strayr: Ready-to-use Australian common structures and classifications and tools for working with them

Parse SEIFA index Spreadsheet

Description

This is a helper function used by get_seifa. The function can also be used independently if you have already downloaded one of the SEIFA index score spreadsheets from https://www.abs.gov.au/AUSSTATS/abs@.nsf/DetailsPage/2033.0.55.0012016?OpenDocument

Usage

get_seifa_index_sheet(
  filename,
  sheetname,
  structure = c("sa1", "sa2", "lga", "postcode", "suburb"),
  data_subclass,
  year
)

Arguments

filename	character name of temporary file when spreadsheet downloaded
sheetname	character name of the sheet to be imported
structure	character spatial structure of the data to be parsed. The spatial structure is important as the shape of the data in the ABS spreadsheets if different for some structures.
data_subclass	character vector matching available SEIFA indexes: irsed - Index of Relative Socio-economic Disadvantage irsead - Index of Relative Socio-economic Advantage and Disadvantage ier - Index of Economic Resources ieo - Index of Education and Occupation
year	a character string or numeric of the release year of SEIFA object, eg "2016"; 2011.

Value

data.frame

Examples

## Not run: 

get_seifa_index_sheet("downloaded_filename.xls", sheetname = "Table 2", structure = "lga")

## End(Not run)

runapp-aus/strayr documentation built on Oct. 15, 2024, 2:19 p.m.