vector-count: Count relationships between a vector and an iv

In DavisVaughan/ivs: Interval Vectors

Count relationships between a vector and an iv

Description

This family of functions counts different types of relationships between a vector and an iv. It works similar to base::match(), where needles[i] checks for a match in all of haystack.

• iv_count_between() counts instances of when needles, a vector, falls between the bounds of haystack, an iv.

• iv_count_includes() counts instances of when needles, an iv, includes the values of haystack, a vector.

These functions return an integer vector the same size as needles containing a count of the times where the i-th value of needles contained a match in haystack.

Usage

iv_count_between(needles, haystack, ..., missing = "equals", no_match = 0L)

iv_count_includes(needles, haystack, ..., missing = "equals", no_match = 0L)

Arguments

needles, haystack	[vector, iv] For iv_*_between(), needles should be a vector and haystack should be an iv. For iv_*_includes(), needles should be an iv and haystack should be a vector. Each element of needles represents the value / interval to match. haystack represents the values / intervals to match against.
...	These dots are for future extensions and must be empty.
missing	[integer(1) / "equals" / "error"] Handling of missing values in needles. "equals" considers missing values in needles as exactly equal to missing values in haystack when determining if there is a matching relationship between them. "error" throws an error if any values in needles are missing. If a single integer value is provided, this represents the count returned for a missing value in needles. Use 0L to force missing values to never match.
no_match	[integer(1) / "error"] Handling of needles without a match. "error" throws an error if any needles have zero matches. If a single integer is provided, this represents the count returned for a needle with zero matches. The default value gives unmatched needles a count of 0L.

Value

An integer vector the same size as needles.

See Also

Locating relationships between a vector and an iv

Examples

x <- as.Date(c("2019-01-05", "2019-01-10", "2019-01-07", "2019-01-20"))

y <- iv_pairs(
  as.Date(c("2019-01-01", "2019-01-03")),
  as.Date(c("2019-01-04", "2019-01-08")),
  as.Date(c("2019-01-07", "2019-01-09")),
  as.Date(c("2019-01-10", "2019-01-20")),
  as.Date(c("2019-01-15", "2019-01-20"))
)

x
y

# Count the number of times `x` is between the intervals in `y`
iv_count_between(x, y)

# Count the number of times `y` includes a value from `x`
iv_count_includes(y, x)

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

a <- c(1, NA)
b <- iv(c(NA, NA), c(NA, NA))

# By default, missing values in `needles` are treated as being exactly
# equal to missing values in `haystack`, so the missing value in `a` is
# considered between the missing interval in `b`.
iv_count_between(a, b)
iv_count_includes(b, a)

# If you'd like to propagate missing values, set `missing = NA`
iv_count_between(a, b, missing = NA)
iv_count_includes(b, a, missing = NA)

# If you'd like missing values to be treated as unmatched, set
# `missing = 0L`
iv_count_between(a, b, missing = 0L)
iv_count_includes(b, a, missing = 0L)

DavisVaughan/ivs documentation built on March 18, 2023, 3:20 p.m.