R/rhrCheckData.R

In jmsigner/rhr: Reproducible Home Ranges with R

##' Check if valid data were provided
##'
##' Check if the provided data meets certain criteria
##' @param dat A data object.
##' @param returnSP A logical value indicating whether or not a \code{SpatialPoints} should be returned.
##' @return \code{data.frame}, \code{SpatialPoints} or \code{STI}
rhrCheckData <- function(dat, returnSP=FALSE) {
  
  
  if (inherits(dat, "RhrTrack")) {
    dat <- rhrPoints(dat)
  }
  
  if (inherits(dat, "RhrTracks")) {
    dat <- rhrPoints(dat)
  }
  
  ## return data.frames
  if (!returnSP) {
    ## remapped already, no need to worry about it anymore
    if (inherits(dat, "RhrMappedData")) {
      return(data.frame(dat$dat)[, c("lon", "lat")])
      ## data.frame
    } else if(inherits(dat, "data.frame")) {
      if (ncol(dat) > 2) {
        dat <- dat[, 1:2]
        warning("rhrCheckData: xy: more than 2 columns, only the first 2 are used")
      }
      return(dat)

      ## complex numbers
    } else if (inherits(dat, "complex")) {
      return(data.frame(x=Re(dat), y=Im(dat)))

      ## SpatialPoints
    } else if (inherits(dat, "SpatialPoints")) {
      return(data.frame(sp::coordinates(dat)))
    } else {
      stop(paste0("rhrCheckData: dat should be of class data.frame, complex or SpatialPoints. The provided dat is of class ", class(dat)))
    }

  } else {

    ## remapped already, no need to worry about it anymore
    if (inherits(dat, "RhrMappedData")) {
      return(dat$dat)

      ## data.frame
    } else if(inherits(dat, "data.frame")) {
      if (ncol(dat) > 2) {
        dat <- dat[, 1:2]
        warning("rhrCheckData: xy: more than 2 columns, only the first 2 are used")
      }
      return(sp::SpatialPoints(dat))

      ## complex numbers
    } else if (inherits(dat, "complex")) {
      return(sp::SpatialPoints(data.frame(x=Re(dat), y=Im(dat))))

      ## SpatialPoints
    } else if (inherits(dat, "SpatialPoints")) {
      return(dat)
    } else {
      stop(paste0("rhrCheckData: dat should be of class data.frame, complex or SpatialPoints. The provided dat is of class ", class(dat)))
    }
  }
}