breaks_to_interval: Convert breaks to an interval

In ageutils: Collection of Functions for Working with Age Intervals

Convert breaks to an interval

Description

breaks_to_interval() takes a specified set of breaks representing the left hand limits of a closed open interval, i.e [x, y), and returns the corresponding interval and upper bounds. The resulting intervals span from the minimum break through to a specified max_upper.

Usage

breaks_to_interval(breaks, max_upper = Inf)

Arguments

breaks	⁠[integerish]⁠. 1 or more non-negative cut points in increasing (strictly) order. These correspond to the left hand side of the desired intervals (e.g. the closed side of [x, y). Double values are coerced to integer prior to categorisation.
max_upper	⁠[numeric]⁠ Represents the maximum upper bound splitting the data. Defaults to Inf.

Value

A tibble with an ordered factor column (interval), as well as columns corresponding to the explicit bounds (lower_bound and upper_bound). Note that even those these bounds are whole numbers they are returned as numeric to allow the maximum upper bound to be given as Inf.

Examples

breaks_to_interval(breaks = c(0L, 1L, 5L, 15L, 25L, 45L, 65L))
breaks_to_interval(
    breaks = c(0L, 1L, 5L, 15L, 25L, 45L, 65L),
    max_upper = 100L
)

ageutils documentation built on Sept. 11, 2024, 7:54 p.m.