cansim (version 0.2.3)

categories_for_level: Use metadata to extract categories for column of specific level

Description

For tables with data with hierarchical categories, metadata containing hierarchy level descriptions is used to extract categories at a specified level of hierarchy only.

Usage

categories_for_level(data, column_name, level = NA, strict = FALSE,
  remove_duplicates = TRUE)

Arguments

data

data table object as returned from get_cansim()

column_name

the quoted name of the column to extract categories from

level

the hierarchy level depth to which to extract categories, where 0 is top category

strict

(default FALSE) when TRUE will only extract that specific hierarchy level

remove_duplicates

(default TRUE) When set to TRUE higher level grouping categories already captured by lower level hierarchy data will be removed

Value

A vector of categories