stri_datetime_create: Create a Date-Time Object#

Description#

Constructs date-time objects from numeric representations.

Usage#

stri_datetime_create(
  year = NULL,
  month = NULL,
  day = NULL,
  hour = 0L,
  minute = 0L,
  second = 0,
  lenient = FALSE,
  tz = NULL,
  locale = NULL
)

Arguments#

year

integer vector; 0 is 1BCE, -1 is 2BCE, etc.; NULL for the current year

month

integer vector; months are 1-based; NULL for the current month

day

integer vector; NULL for the current day

hour

integer vector; NULL for the current hour

minute

integer vector; NULL for the current minute

second

numeric vector; fractional seconds are allowed; NULL for the current seconds (without milliseconds)

lenient

single logical value; should the operation be lenient?

tz

NULL or '' for the default time zone or a single string with time zone identifier, see stri_timezone_list

locale

NULL or '' for default locale, or a single string with locale identifier; a non-Gregorian calendar may be specified by setting @calendar=name keyword

Details#

Vectorized over year, month, day, hour, hour, minute, and second.

Value#

Returns an object of class POSIXct.

Author(s)#

Marek Gagolewski and other contributors

See Also#

The official online manual of stringi at https://stringi.gagolewski.com/

Gagolewski M., stringi: Fast and portable character string processing in R, Journal of Statistical Software 103(2), 2022, 1-59, doi:10.18637/jss.v103.i02

Other datetime: stri_datetime_add(), stri_datetime_fields(), stri_datetime_format(), stri_datetime_fstr(), stri_datetime_now(), stri_datetime_symbols(), stri_timezone_get(), stri_timezone_info(), stri_timezone_list()

Examples#

stri_datetime_create(2015, 12, 31, 23, 59, 59.999)
## [1] "2015-12-31 23:59:59 CET"
stri_datetime_create(5775, 8, 1, locale='@calendar=hebrew')  # 1 Nisan 5775 -> 2015-03-21
## [1] "2015-03-21 CET"
stri_datetime_create(2015, 02, 29)
## [1] NA
stri_datetime_create(2015, 02, 29, lenient=TRUE)
## [1] "2015-03-01 CET"
stri_datetime_create(hour=15, minute=59)
## [1] "2024-05-06 15:59:00 CEST"