phinterval (version 1.0.0)

phinterval-accessors: Accessors for the endpoints of a phinterval

Description

phint_start() and phint_end() return the earliest and latest endpoint of each phinterval element, respectively. Holes (empty time spans) are returned as NA.

phint_starts() and phint_ends() return lists of all start and end points for each phinterval element, respectively. For phintervals with multiple disjoint spans, each span's endpoint is included. Holes are returned as length-0 <POSIXct> vectors.

Usage

phint_start(phint)
# S3 method for default
phint_start(phint)
# S3 method for Interval
phint_start(phint)
# S3 method for phinterval
phint_start(phint)
phint_end(phint)
# S3 method for default
phint_end(phint)
# S3 method for Interval
phint_end(phint)
# S3 method for phinterval
phint_end(phint)
phint_starts(phint)
# S3 method for default
phint_starts(phint)
# S3 method for Interval
phint_starts(phint)
# S3 method for phinterval
phint_starts(phint)
phint_ends(phint)
# S3 method for default
phint_ends(phint)
# S3 method for Interval
phint_ends(phint)
# S3 method for phinterval
phint_ends(phint)

Value

For phint_start() and phint_end(), a <POSIXct> vector the same length as phint.

For phint_starts() and phint_ends(), a list of <POSIXct> vectors the same length as phint.

Arguments

phint

[phinterval / Interval]

A <phinterval> or <Interval> vector.

Examples

int1 <- interval(as.Date("2020-01-10"), as.Date("2020-02-01"))
int2 <- interval(as.Date("2023-05-02"), as.Date("2023-06-03"))

phint_start(int1)
phint_end(int1)

# Holes have no endpoints; disjoint phintervals have multiple endpoints
hole <- phint_intersect(int1, int2)
disjoint <- phint_union(int1, int2)

phint_start(c(hole, disjoint))
phint_starts(c(hole, disjoint))

phint_end(c(hole, disjoint))
phint_ends(c(hole, disjoint))

# phint_start() and phint_end() return the minimum and maximum endpoints
negative <- interval(as.Date("1980-01-01"), as.Date("1979-12-27"))
phint_start(negative)
phint_end(negative)