R/totaltravelout_samerate_regulated.R

In leminhthien2011/CONETTravel: What the Package Does is (Title Case)

#' This function gives a list of total travel data allowed from 1 country to
#'  another for a given in rate.
#' @param traveloutdat is the data of travel out from each country without pandemic
#' @param ratein numeric values of rate let people in
#' @param P vector population of countries in order as travel data
#' @return  A list of number travelers can go from 1 country to another each day during the duration
#' @examples
#' \dontrun{
#' For 3 countries
#' P1 = 10^7
#' P2 = 3*10^6
#' P3 = 2*10^6
#' P = c(P1, P2, P3) #population of 3 countries
#' traveloutdat = travelout_3dat
#' ratein = 1 # policy that allows full rate of travel in
#' totaltravelout_samerate_regulated(traveloutdat, ratein, P)
#' ##########################
#' For 2 countries
#' P1 = 10^7
#' P2 = 3*10^6
#' P = c(P1, P2) #population of 2 countries
#' traveloutdat = travelout_3dat[,1:2] #travel out of 2 countries
#' ratein = .5 # policy that allows full rate of travel in
#' totaltravelout_samerate_regulated(traveloutdat, ratein, P)
#' }


#' @import matrixcalc
#' @export


totaltravelout_samerate_regulated =  function(traveloutdat,ratein, P){
  ##Construct a divide list travel out
  numberCountries = ncol(traveloutdat)

  traveloutDivide = list()

  for (j in 1:nrow(traveloutdat)){
    tmp = traveloutdat[j,]
    ##CREATE MATRIX TRAVELOUT EACH ROW
    travelmat = matrix(0,nrow = numberCountries, ncol = numberCountries)
    for(i in 1:numberCountries){
      ones = rep(1,numberCountries)
      travelmat[i,] = kronecker(ones,as.numeric(tmp[i]) )
    }
    ##CREATE THE PROPORTION OF POPULATION MATRIX
    ones = t(t(rep(1,numberCountries)))
    popmat = kronecker(ones,t(P))
    ##
    denommat = matrix(0,nrow = numberCountries, ncol = numberCountries)
    for(i in 1:numberCountries){
      tmp = sum(P[-i])
      ones = rep(1,numberCountries)
      denommat[i,] = kronecker(ones,as.numeric(tmp) )
    }
    ##Take product for proportion
    promat = popmat*denommat^(-1)
    diag(promat) = 0
    # Take Hadamard product for actual number
    traveloutDivide[[j]] = hadamard.prod(promat, travelmat)
  }


  ##Matrix list of traveling
  durationtravel = nrow(traveloutdat)




  policymatlist = list()

  for(i in 1:durationtravel){
    tmp =  matrix(ratein, nrow = numberCountries, ncol = numberCountries)
    diag(tmp) = 0
    policymatlist[[i]] = tmp

  }

  ############Matrix travel when percentage of travel in regulated
  traveloutDivideRegulated = list()
  for (i in 1:nrow(traveloutdat)){

    tmp1 = as.matrix(traveloutDivide[[i]])
    tmp2 = as.matrix(policymatlist[[i]])

    traveloutDivideRegulated[[i]] = round(hadamard.prod(tmp1, tmp2), digits=0)
  }

  return(traveloutDivideRegulated)
}
######