R/utils.R

In eyelinker: Import ASC Files from EyeLink Eye Trackers

#' From a set of intervals, find which interval values belong to
#'
#' Returns which interval (if any) each number in a vector belongs to, given a set of
#' user-defined intervals. Intervals can be specified using either two-column matrices or
#' \code{\link[intervals:Intervals-class]{Intervals}} objects from the \code{intervals} package.
#' @param x A vector of numeric values
#' @param Intv A two-column matrix or an object of class Intervals
#' @return For each value in x: if x[i] is in the set of intervals, the index of the corresponding
#'   interval(s), NA if no interval contains x[i]
#' @seealso \%In\%
#' @examples
#' start <- c(0, 1, 2)
#' end <- c(.5, 1.3, 3)
#' intv <- cbind(start, end) # The first interval is 0-0.5, second is 1-1.3, etc.
#' whichInterval(seq(0, 3, l = 10), intv)
#' @author Simon Barthelme
#' @export
whichInterval <- function(x, Intv) {

    if (is.integer(x)) x <- as.double(x)
    if (is.matrix(Intv)) {
        Intv <- Intervals(Intv)
    }
    wn <- which_nearest(x, Intv)
    notFound <- wn$distance_to_nearest != 0
    if (any(notFound)) {
        wn[notFound, ]$which_nearest <- NA
    }
    # Check if we can simplify output
    if (all(sapply(wn$which_nearest, length) == 1)) {
        wn$which_nearest <- do.call('c', wn$which_nearest)
    }
    wn$which_nearest
}

#' @rdname whichInterval
#' @export
which_interval <- whichInterval  # Alias for keeping with tidyverse-style naming conventions

#' Find if value belongs to a set of intervals
#'
#' Returns whether numeric values on the left-hand side of the operator fall within any of the
#' specified intervals on the right-hand side. Intervals can be specified using either two-column
#' matrices or \code{\link[intervals:Intervals-class]{Intervals}} objects from the
#' \code{intervals} package.
#' @param x A vector of numeric values
#' @param Intv A set of intervals, defined by a two-column matrix of endpoints or an Intervals
#'   object
#' @return A vector of logicals, which are true if x[i] belongs to any of the intervals in the set.
#' @author Simon Barthelme
#' @examples
#' start <- c(0, 1, 2)
#' end <- c(.5, 1.3, 3)
#' intv <- cbind(start, end) # The first interval is 0-0.5, second is 1-1.3, etc.
#' c(0, .6, 1.5, 3) %In% intv
#' @export
`%In%` <- function(x, Intv) {
    if (is.integer(x)) x <- as.double(x)
    if (is.matrix(Intv)) {
        Intv <- Intervals(Intv)
    }
    distance_to_nearest(x, Intv) == 0
}

#' @rdname grapes-In-grapes
#' @export
`%within%` <- `%In%`  # Alias for keeping with tidyverse-style naming conventions