Nothing
#' Default formatting strings for chronons
#'
#' Provides default linear time formatting strings for a given chronon (finest
#' time granule). The format strings use placeholders like `{lin(year(1L))}`,
#' `{cyc(month(1L), year(1L)}` and `{cyc(day(1L), month(1L)}`, which are
#' evaluated in the context of the data's [`time_calendar()`].
#'
#' @param x A time granule for the chronon.
#' @param y A time granule for the cycle
#' @param cal The calendar of the chronon, used to disambiguate suitable format
#' strings for time units that are shared across calendars (e.g.
#' `cal_gregorian$day` and `cal_isoweek$day`).
#' @param ... Additional arguments for methods.
#'
#' @return A character string containing the default format template for the chronon.
#'
#' @export
#' @examples
#' chronon_format_linear(cal_gregorian$year(1L))
#' chronon_format_linear(cal_gregorian$month(1L))
#' chronon_format_linear(cal_gregorian$day(1L))
#' chronon_format_linear(cal_isoweek$day(1L))
#'
#' @rdname chronon_format
chronon_format_linear <- new_generic("chronon_format_linear", c("x", "cal"), function(x, cal = time_calendar(x), ...) {
S7::S7_dispatch()
})
method(chronon_format_linear, list(mt_unit, class_any)) <- function(x, cal) {
paste0(unit_symbol(x), "{lin(chronon_glb(.time))}")
}
#' @examples
#' chronon_format_cyclical(cal_gregorian$month(1L), cal_gregorian$year(1L))
#' chronon_format_cyclical(cal_gregorian$day(1L), cal_gregorian$month(1L))
#' chronon_format_cyclical(cal_isoweek$day(1L), cal_isoweek$week(1L))
#' chronon_format_cyclical(cal_isoweek$week(1L), cal_isoweek$year(1L))
#'
#' @rdname chronon_format
#' @export
chronon_format_cyclical <- new_generic("chronon_format_cyclical", c("x", "y"))
method(chronon_format_cyclical, list(mt_unit, mt_unit)) <- function(x, y) {
paste0(unit_symbol(x), "{cyc(chronon_glb(.time), chronon_glb(time_cycle(.time)))}")
}
#' @examples
#' chronon_format_duration(cal_gregorian$year(1L))
#' chronon_format_duration(cal_gregorian$month(1L))
#' chronon_format_duration(cal_gregorian$day(1L))
#'
#' @rdname chronon_format
#' @export
chronon_format_duration <- new_generic("chronon_format_duration", "x")
method(chronon_format_duration, mt_unit) <- function(x) {
"{duration_label(.time)}"
}
# A duration as text, e.g. "3 months" or "1.5 days". This is time_granule_label()
# over the magnitudes of a duration vector, except that continuous (double)
# durations show a fractional magnitude and always read as plural. Magnitudes
# count chronons, so they are scaled by the chronon's size: 2 chronons of
# `hour(3L)` read as "6 hours".
duration_label <- function(x) {
chronon <- chronon_glb(x)
n <- vec_data(x)
# Continuity follows the duration's own storage, not the size's type (so a
# discrete duration of `hour(3)`, with a double size, still reads "3 hours").
continuous <- is.double(n)
n <- n * chronon@n
if (continuous) {
paste(format(n, nsmall = 1L), unit_name(chronon, 2L))
} else {
time_granule_label(chronon, n)
}
}
#' Default formatting strings for chronon attributes
#'
#' Provides suffixes for default formatting strings for a given chronon (time granule).
#' This provides useful information such as timezones or locations in the string.
#'
#' @param x A chronon (time granule) object.
#' @param ... Additional arguments for methods.
#'
#' @return A character string containing the default format suffix for the chronon.
#'
#' @export
chronon_format_attr <- new_generic("chronon_format_attr", "x")
method(chronon_format_attr, mt_unit) <- function(x) {
""
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.