R/calculate_wgt_corr.R

In lorecatta/DENVfoiMap: Runs the analysis of the paper on global dengue FOI mapping and prediction of intervention impact

#------------------------------------------------------------------------------

#' The function calculates a weighted Pearson correlation coefficient between
#' variable A and B using \code{\link{wtd.cor}}.
#'
#' @title Calculate weighted Pearson correlation coefficient
#'
#' @param d.sub a dataframe with data.
#'
#' @param x character string of the name of variable A.
#'
#' @param y character string of the name of variable B.
#'
#' @importFrom weights wtd.cor
#'
#' @return the numeric value of the correlation coefficient.
#'
#' @export


calculate_wgt_cor <- function(d.sub, x, y){

  round(wtd.cor(d.sub[,x], d.sub[,y], weight = d.sub[,"new_weight"])[,"correlation"], 3)

}