Learn R Programming

aion (version 1.4.0)

calendar_get: Calendar Parameters

Description

Calendar Parameters

Usage

calendar_label(object)

calendar_name(object)

calendar_unit(object)

calendar_epoch(object)

calendar_fixed(object)

calendar_direction(object)

calendar_year(object)

# S4 method for TimeScale calendar_label(object)

# S4 method for TimeScale calendar_name(object)

# S4 method for TimeScale calendar_unit(object)

# S4 method for TimeScale calendar_epoch(object)

# S4 method for TimeScale calendar_fixed(object)

# S4 method for TimeScale calendar_direction(object)

# S4 method for NULL calendar_direction(object)

# S4 method for TimeScale calendar_year(object)

Value

  • calendar_label() returns a character string giving the abbreviated label of the time scale.

  • calendar_name() returns a character string giving the name of the time scale.

  • calendar_unit() returns a character string giving the unit of the calendar.

  • calendar_fixed() returns a length-one numeric vector giving the reference date of the calendar (in rata die).

  • calendar_epoch() returns a length-one numeric vector giving the epoch year from which years are counted (starting date of the calendar, in years).

  • calendar_direction() returns a length-one integer vector specifying if years are counted backwards (\(-1\)) or forwards (\(1\)) from epoch. Only the sign of calendar_direction() is relevant.

  • calendar_year() returns a length-one numeric vector giving the average length of the year in solar days.

Arguments

object

A TimeScale object.

Author

N. Frerebeau

See Also

Other calendar tools: calendar(), convert(), get_calendar(), gregorian, is_calendar(), julian()

Examples

Run this code
## Define time scales
calendar("BP")
calendar("AD")
calendar("julian")

## Shortcuts
BP()
AD()
J()

Run the code above in your browser using DataLab