Package index • mixtime

Linear Time Representations

Functions to create and work with linear time representations

Linear Time Vectors

The general function for creating linear time representations

linear_time(): Linear time points

Linear Time Helpers

Convenience functions for common linear time representations

year() yearquarter() yearmonth() yearweek() date() datetime(): Linear time helper functions

Cyclical Time Representations

Functions to create and work with cyclical time representations

Cyclical Time Vectors

The general function for creating cyclical time representations

cyclical_time(): Cyclical time points

Cyclical Time Helpers

Convenience functions for common cyclical time representations

month_of_year() day_of_year() day_of_month() time_of_day() day_of_week() week_of_year(): Cyclical time helpers

Time Manipulation

Functions for manipulating and transforming time objects.

seq(<mixtime>) seq(<mt_time>): Generate sequences of mixtime values
round_time() ceiling_time() floor_time(): Round, floor and ceiling transformations for time objects

Calendar Systems

Calendar systems are composed of their associated time units. These define how time is divided and measured in different calendar systems.

Gregorian Calendar System

The standard civil calendar system with years, quarters, months, days, and sub-day units.

cal_gregorian: Gregorian time unit classes

ISO 8601 Calendar System

The ISO 8601 week date calendar system with ISO years and weeks.

cal_isoweek: ISO 8601 time unit classes

Symmetry454 Calendar System

The Symmetry454 calendar system with years, months, weeks, and days.

cal_sym454: Symmetry454 time unit classes

Custom Calendars

Functions for creating custom calendar systems

new_calendar(): Create a new calendar

Time Systems

Time systems define when the boundary of a day occurs and how a day is divided into time units. These can be combined with calendar systems to create custom time representations.

Civil Time System

The civil time system where each day begins at midnight on the 24-hour clock in a specific time zone.

cal_time_civil_midnight: Civil time unit classes

Solar Time Systems

Solar time systems where day boundaries are defined by solar events (sunrise, noon, or sunset) at specific geographic locations.

cal_time_solar_sunset cal_time_solar_sunrise cal_time_solar_noon cal_time_solar_midnight cal_time_solar_dawn cal_time_solar_dusk: Solar time unit classes

Lunar Time System

The lunar time system where each month begins at the new moon, with day boundaries defined by lunar events.

cal_time_lunar: Lunar time unit classes

Time Attributes

Functions for working with attributes of time units, such as timezones or locations.

Timezones

Functions for working with timezones and timezone information

tz_name(): Extract timezone from an object
tz_offset(): Get timezone offset
tz_abbreviation(): Get timezone abbreviation
tz_transitions(): Get timezone transitions

Locations

Functions for working with geographic locations and their associated information

loc_latitude() loc_longitude() loc_altitude(): Extract locations from an object

Mixtime Objects

Functions for creating and working with mixtime objects that can contain multiple time granularities.

mixtime(): Create a mixtime vector
new_mixtime(): Constructor for mixtime vectors
new_time(): Constructor for mixtime time vectors
as_mixtime(): Convert a time class into a mixtime
is_mixtime(): Check if an object is a mixtime

Mixtime Accessors

Functions for accessing the components of mixtime objects.

time_calendar(): Obtain the calendar of a time object
time_chronon(): Obtain the chronon of a time object
time_cycle(): Obtain the cycle of a time object

Extensibility methods

These low-level functions define the relationships and labels between time units. Adding S7 methods for them allow the creation of custom time units and calendars.

Time units and calendars

new_calendar(): Create a new calendar
mt_unit() mt_loc_unit() mt_tz_unit(): Base S7 class for creating new time units

Calendar arithmetic

chronon_cardinality() chronon_cardinality.S7_methods(): Cardinality between time units
chronon_divmod() chronon_divmod.S7_methods(): Convert between chronons of different time units
chronon_epoch(): Epoch offset for chronons
circsum(): Compute circular rolling sums

Time labels and formatting

time_unit_full() time_unit_abbr(): Time units as a string
linear_labels() linear_labels.S7_methods(): Friendly labels for linear relationships
cyclical_labels() cyclical_labels.S7_methods(): Friendly labels for cyclical relationships
chronon_format_linear() chronon_format_cyclical(): Default formatting strings for chronons
chronon_format_attr(): Default formatting strings for chronon attributes

Convenience function factories

new_cyclical_time_fn(): Cyclical time function factory
new_linear_time_fn(): Linear time function factory