R/hdiffcoords.R

In MikkoVihtakari/SuitableHabitat: Estimate Habitat Spaces for Geographic Suitable Habitat Models

#' @title Print overlapping and unique bin centroid coordinates for two hexbin objects
#' @param bin1,bin2 two objects of class hexbin.
#' @details The hexbin objects for comparison, bin1 and bin2, must have the same plotting limits and cell size.
#' @return Returns a list of data frames with unique coordinates for \code{bin1} and \code{bin2} as well as overlapping coordinates among bins.
#' @import hexbin
#' @keywords internal
#' @export

hdiffcoords <- function(bin1, bin2) {

  ## Checks modified from: https://github.com/edzer/hexbin/blob/master/R/hdiffplot.R
  if(is.null(bin1) | is.null(bin1)) {
    stop("Need 2 hex bin objects")
  } else {
        if(bin1@shape != bin2@shape)
            stop("Bin objects must have same shape parameter")
        if(all(bin1@xbnds == bin2@xbnds) & all(bin1@ybnds == bin2@ybnds))
            equal.bounds <- TRUE
        else stop("Bin objects need the same xbnds and ybnds")
        if(bin1@xbins != bin2@xbins)
            stop("Bin objects need the same number of bins")
  }

  ## Find overlapping and unique bins

  hd1 <- data.frame(hcell2xy(bin1), count_bin1 = bin1@count, cell_bin1 = bin1@cell)
  hd2 <- data.frame(hcell2xy(bin2), count_bin2 = bin2@count, cell_bin2 = bin2@cell)

  overlapping_hd1 <- apply(hd1, 1, function(r, A){ sum(A$x==r[1] & A$y==r[2]) }, hd2)
  overlapping_hd2 <- apply(hd2, 1, function(r, A){ sum(A$x==r[1] & A$y==r[2]) }, hd1)

  overlaps <- merge(hd1[as.logical(overlapping_hd1),], hd2[as.logical(overlapping_hd2),])

  unique_hd1 <- hd1[!as.logical(overlapping_hd1),]
  unique_hd2 <- hd2[!as.logical(overlapping_hd2),]

  ## Return list of data.frames

  out <- list(unique_bin1 = unique_hd1, unique_bin2 = unique_hd2, overlapping = overlaps)

  lapply(out, function(k) {
    names(k)[names(k) == "x"] <- "lon"
    names(k)[names(k) == "y"] <- "lat"
    k
  })


}