Package index • mixtime

Linear Time Representations

Functions to create and work with linear time

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

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 Duration Representations

Functions to create and work with time durations

Time Duration Vectors

The general function for creating time durations

duration(): Duration vectors

Time Duration Helpers

Convenience functions for common time durations

years() quarters() months() weeks() days() hours() minutes() seconds() milliseconds(): Duration helper functions

Time Manipulation

Functions for manipulating and transforming time vectors.

seq(<mixtime::mixtime>) seq(<mixtime::mt_time>): Generate sequences of mixtime values
time_round() time_ceiling() time_floor(): Round, floor and ceiling transformations for time objects

Comparison operators

Methods for comparing time vectors.

`==`(<mt_linear>) `!=`(<mt_linear>) `<`(<mt_linear>) `<=`(<mt_linear>) `>`(<mt_linear>) `>=`(<mt_linear>): Comparison operators for linear time (mt_linear)
`==`(<mt_duration>) `!=`(<mt_duration>) `<`(<mt_duration>) `<=`(<mt_duration>) `>`(<mt_duration>) `>=`(<mt_duration>): Comparison operators for durations (mt_duration)
`==`(<mt_cyclical>) `!=`(<mt_cyclical>) `<`(<mt_cyclical>) `<=`(<mt_cyclical>) `>`(<mt_cyclical>) `>=`(<mt_cyclical>): Comparison operators for cyclical time (mt_cyclical)

Time Components

Functions for extracting and referring to linear and cyclical components of time.

time_components(): Extract linear and cyclical time components
time_compose(): Compose a linear time vector from linear and cyclical components
lin() cyc(): Linear and cyclical component helpers

Parsing and Formatting Time

Functions for converting between character strings and time vectors.

time_parse(): Parse text into a time point
format(<mt_time>): Format mixtime vectors

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: 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_transit cal_time_solar: 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_synodic cal_time_lunar: Lunar time unit classes

Time Attributes

Functions for working with attributes of time granules, 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
class_mixtime(): Base S7 class for mixtime vector objects
new_time() deprecated: Constructor for mixtime time vectors
as_mixtime(): Convert a time class into a mixtime
is_mixtime(): Check if an object is a mixtime
time_is_linear() time_is_cyclical() time_is_duration() is_time_linear() is_time_cyclical() is_time_duration(): Check the time type of values
time_is_determinate_at(): Test whether time is determinate at a granule's precision
time_is_complete_at(): Test whether a granule is completed at a time point
chronon_common() chronon_common.mixtime(): Find the common chronon of a time object

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_time_unit(): Create a new time unit class
new_calendar(): Create a new calendar
mt_unit() mt_loc_unit() mt_tz_unit(): Base S7 class for creating new time units
mt_linear() mt_duration() mt_cyclical(): Time vector classes

Calendar arithmetic

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

Time labels and formatting

time_unit_full() time_unit_plural() time_unit_abbr(): Time units as a string
label_scheme() linear_labels() cyclical_labels(): Describe a granule's label scheme
linear_labels_format() cyclical_labels_format() linear_labels_parse() cyclical_labels_parse(): Render and parse a granule's labels
vocab_table(): Build a vocab function from a plain name table
chronon_format_linear() chronon_format_cyclical() chronon_format_duration(): Default formatting strings for chronons
chronon_format_attr(): Default formatting strings for chronon attributes
parse_format(): Candidate format strings for parsing time
chronon_parse_linear() chronon_parse_cyclical(): Default parsing format strings for chronons

Convenience function factories

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