R/weighted.avg.r

Defines functions weighted.avg

Documented in weighted.avg

#' Compute a weighted average of regions or industries from regions - industries matrices
#'
#' This function computes a weighted average of regions or industries from (incidence) regions - industries matrices.
#' @param mat An incidence matrix with regions in rows and industries in columns
#' @param vec A vector that will be used to compute the weighted average for each industry/region
#' @param reg Logical; Shall the weighted average for regions be returned? Default to TRUE (requires a vector of industry value) but can be set to FALSE (requires a vector of region value) if the weighted average for industries should be returned
#' @keywords diversity specialization
#' @export
#' @examples
#' ## generate a region - industry matrix
#' set.seed(31)
#' mat <- matrix(sample(0:100,20,replace=T), ncol = 4)
#' rownames(mat) <- c ("R1", "R2", "R3", "R4", "R5")
#' colnames(mat) <- c ("I1", "I2", "I3", "I4")
#'
#' ## a vector for regions will be used to computed the weighted average of industries
#' vec <- c (5, 10, 15, 25, 50)
#' ## run the function
#' weighted.avg (mat, vec, reg = F)
#'
#' ## a vector for industries will be used to computed the weighted average of regions
#' vec <- c (5, 10, 15, 25)
#' ## run the function
#' weighted.avg (mat, vec, reg = T)
#' @author Pierre-Alexandre Balland \email{p.balland@uu.nl}
#' @seealso \code{\link{location.quotient}}

weighted.avg <- function(mat, vec, reg = T) {

  if (reg) {
  tt = t(mat / rowSums (mat))
  w = vec %*% tt
  return (w)
  }

  if (!reg) {
  tt = t(mat)/(rowSums(t(mat)))
  w = vec%*% t(tt)
  return (w)
  }

}
PABalland/EconGeo documentation built on Nov. 13, 2020, 2:50 a.m.