ce_uccs {cepumd} | R Documentation |
Find UCCs for expenditure categories
Description
Find UCCs for expenditure categories
Usage
ce_uccs(hg, expenditure = NULL, ucc_group = NULL, uccs_only = TRUE)
Arguments
hg |
A data frame that has, at least, the title, level, and ucc columns of a CE HG file. |
expenditure |
A string that is an expenditure category contained in a CE HG file (exact match required). Either expenditure or ucc_group is required. The default is NULL. |
ucc_group |
A string indicating an expenditure category by UCC group in a CE HG file (exact match required). Either expenditure or ucc_group is required. The default is NULL. |
uccs_only |
A logical indicating whether to return only the expenditure category's component ucc's. If TRUE (default), a vector of UCC's will be returned. If FALSE, a dataframe will be returned containing the section of the HG file containing the expenditure category and its component sub- categories |
Details
If both a valid expenditure and valid ucc_group are input, ucc_group will be used.
Value
A vector of Universal Classification Codes (UCC's) corresponding to the lowest hierarchical level for that category.
Examples
## Not run:
# First generate an HG file
my_hg <- ce_hg(2021, interview, hg_file_path = "CE-HG-Inter-2021.txt")
# Store a vector of UCC's in the "Pets" category
pet_uccs <- ce_uccs(my_hg, "Pets")
pet_uccs
# [1] "610320" "620410" "620420"
## End(Not run)