Date Conversion to Character

Date Conversion to Character

Usage

# S4 method for class 'TimeIntervals'
format(x, calendar = get_calendar(), ...)

# S4 method for class 'TimeScale'
format(x, ...)

# S4 method for class 'RataDie'
format(
  x,
  prefix = c("a", "ka", "Ma", "Ga"),
  label = TRUE,
  calendar = get_calendar(),
  ...
)

Arguments

x

A RataDie object.

calendar

A TimeScale object specifying the target calendar (see calendar()).

...

Currently not used.

prefix

A character string specifying the prefix. It should be one of "a", "ka", "Ma" or "Ga". If TRUE, a good guess for an appropriate format is made.

label

A logical scalar: should the label of the calendar be displayed?

Value

A character vector representing the date.

See also

Other fixed date tools: arithmetic, as_date(), as_decimal(), as_fixed(), as_year(), fixed(), fixed_gregorian, fixed_julian, pretty()

Author

N. Frerebeau

Examples

## R 1.0.0
(y <- fixed(year = 2000, month = 02, day = 29, calendar = CE()))
#> Rata die: number of days since 01-01-01 (Gregorian)
#> [1] 730179
as_date(y, calendar = CE())
#>   year month day
#> 1 2000     2  29
as_year(y, calendar = CE())
#> [1] 2000.161

## Create a vector of years BP (Gregorian)
## (every two years starting from 2000 BP)
(years <- seq(from = 2000, by = -2, length.out = 10))
#>  [1] 2000 1998 1996 1994 1992 1990 1988 1986 1984 1982
## Convert years to rata die
(rd <- fixed(years, calendar = BP()))
#> Rata die: number of days since 01-01-01 (Gregorian)
#>  [1] -18627 -17897 -17166 -16436 -15705 -14975 -14244 -13514 -12783 -12053
## Convert back to Gregorian years BP
as_year(rd, calendar = BP())
#>  [1] 2000 1998 1996 1994 1992 1990 1988 1986 1984 1982

## More convenient
(rd <- fixed_from_BP(years))
#> Rata die: number of days since 01-01-01 (Gregorian)
#>  [1] -18627 -17897 -17166 -16436 -15705 -14975 -14244 -13514 -12783 -12053
fixed_to_BP(rd)
#>  [1] 2000 1998 1996 1994 1992 1990 1988 1986 1984 1982