calendar_get: Calendar Parameters

calendar_getR Documentation

Calendar Parameters

Description

Calendar Parameters

Usage

calendar_label(object)

calendar_name(object)

calendar_unit(object)

calendar_epoch(object)

calendar_fixed(object)

calendar_direction(object)

## S4 method for signature 'TimeScale'
calendar_label(object)

## S4 method for signature 'TimeScale'
calendar_name(object)

## S4 method for signature 'TimeScale'
calendar_unit(object)

## S4 method for signature 'TimeScale'
calendar_epoch(object)

## S4 method for signature 'TimeScale'
calendar_fixed(object)

## S4 method for signature 'TimeScale'
calendar_direction(object)

## S4 method for signature 'NULL'
calendar_direction(object)

Arguments

object

A TimeScale object.

Value

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

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

  • calendar_unit() returns a character string specifying the name of the calendar.

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

  • calendar_epoch() returns a length-one numeric vector specifying 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.

Author(s)

N. Frerebeau

See Also

Other calendar tools: calendar(), convert(), gregorian, is(), julian()

Examples

## Define time scales
calendar("BP")
calendar("AD")
calendar("julian")

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

aion documentation built on Oct. 4, 2024, 5:07 p.m.