R/RR.table.add.R

In ejanalysis/ejanalysis: Tools for Environmental Justice (EJ) Analysis

#' @title Merge tables of Relative Risk results
#' @description Merge table of Relative Risk results for some zones with table for USA overall
#' @param rrs1 First table from RR.table()
#' @param rrs2 Another table from RR.table()
#' @param zones2 Zones in rrs2, as vector, default is third element of dimnames(rrs2)
#' @return Returns a new array
#' @seealso [RR()]
#' @examples
#'
#'  RRS.US  <- RR.table(mydat=bg, Enames=names.e, Dnames=c(names.d, names.d.subgroups.pct),
#'   popcolname='pop')
#'  RRS.ST  <- RR.table(mydat=bg, Enames=names.e, Dnames=c(names.d, names.d.subgroups.pct),
#'   popcolname='pop', Zcolname='ST')
#'  RRS <- RR.table.add(RRS.ST, RRS.US)
#'  # RRS[ "pctlowinc", , ]
#'  # RRS[ , ,  "CA"]
#'  # RRS[ , "pm", ]
#'  RR.table.sort(RRS)
#'
#'  RRS.REGION  <- RR.table(mydat=bg, Enames=names.e, Dnames=c(names.d, names.d.subgroups.pct),
#'   popcolname='pop', Zcolname='REGION')
#'  RRS2 <- RR.table.add(RRS, RRS.REGION)
#'  # RRS2[ , , "8"]
#'
#' @export
#'
RR.table.add <- function(rrs1, rrs2, zones2) {

  ########################### #
  # MERGE ANY TABLE OF ZONES AND US TABLE *****
  ########################### #
  # Function to merge set of Relative Risk tables as 3D array from RR.table() with one or more such tables
  # e.g., for the overall area (aggregate of those places), also from RR.table()

  zones2 <- dimnames(rrs2)[[3]]
  len1 <- dim(rrs1)[3]
  len2 <- dim(rrs2)[3]
  RRS <- array(dim=c(dim(rrs1)[1], dim(rrs1)[2], len1 + len2 ) )
  RRS[ , , 1:len1 ]   <- rrs1
  RRS[ , , (1 + len1):(len1 + len2) ] <- rrs2
  dimnames(RRS) <- list( dimnames(rrs1)[[1]], dimnames(rrs1)[[2]], c(dimnames(rrs1)[[3]], zones2) )
  return(RRS)
}