R/Abridge.R

In DDM: Death Registration Coverage Estimation

# Author: tim
###############################################################################


#' @title single ages to standard abridged ages
#' @description convert ages of the form 0,1,2,3,4,5,... into 0,1,1,1,1,5,...
#' 
#' @param x vector of single ages (lower bound) a.k.a. completed age.
#' 
#' @return vector of the same length indicating which abridged age group each single age belongs to (lower bound)

#' @export

single2abr <- function(x){
	stopifnot(is.integer(x))
	x5 <- x - x %% 5
	x5[x %in% c(1:4)] <- 1
	x5
}

##' @title Abridge population or death data 
##' @description This function assumes you have columns named Age, Sex, AgeInterval, and Year
##' 
##' @importFrom data.table data.table
#Abridge <- function(X, value.var = "Deaths"){
#	# assume we have Age, AgeInterval, etc.
#	
#	X <- as.data.table(X)
#	
#	# this doesn't do regions...
#	X[,Age5 := single2abr(Age), by = c(Year, Sex)]
#	
#	#
#	# test: value.var might not pass properly, need live data
#	X[,list(V1=sum(value.var),AgeInterval5 = sum(AgeInterval)), by = c(Age5, Year, Sex)]
#	
#	# rename new abridged column
#	setnames(X,"V1", value.var)
#	setnames(X,"Age5", "Age")
#	
#	
#	# that's that!
#	X <- as.data.frame(X)
#	
#	X
#}