R/binomialOverlap.R

In JCur96/sfe: Adds Useful Tools for Ecologists to the sf Package

#' Turns percentage overlap data into binomial data
#'
#' \code{binomialOverlap} turns previously calculated percentage overlap data
#' into binomial (yes/no or 1/0) overlap data on a per species basis. This is in
#' preparation for analysis using binomial GLMM's.
#'
#' You will get a warning messages saying only the first value will be used to
#' check if an \code{if} condition is true, these arise due to R interpreting
#' the column of \code{Percent_overlap} as a list, so can be safely ignored.
#'
#' @param x an object of class sf, sfc or sfg, containing calculated percentage
#' overlaps of range polygons between Natrual History Museum data and IUCN data.
#'
#' @return \code{x} with the \code{Percent_overlaps} column "flattened" to
#' binomial data and stored in the \code{binomial_overlap} column.
#'
#' @examples
#' x <- binomialOverlap(x)
#' @export
binomialOverlap <- function(x) {
  x['binomial_overlap'] <- NA
  myvars <- c('Percent_overlap')
  tmp <- x[myvars]
  st_geometry(tmp) <- NULL
  # print(tmp)
  for (row in 1:nrow(x)) {
    PO <- tmp$Percent_overlap[row]
    if ((PO > 0.0) == T) {
      x[row, 'binomial_overlap'] <- 1
    } else if (PO == 0.0) {
      x[row, 'binomial_overlap'] <- 0
    }
  }
  return(x)
}