Hide navigation sidebar
Hide table of contents sidebar
Back to top
Edit this page
Toggle table of contents sidebar

# stri_datetime_fields: Get Values for Date and Time Fields

## Description

Computes and returns values for all date and time fields.

## Usage

    stri_datetime_fields(time, tz = attr(time, "tzone"), locale = NULL)

## Arguments

`time` | an object of class `POSIXct` (`as.POSIXct` will be called on character vectors and objects of class `POSIXlt`, `Date`, and `factor`)
`tz` | `NULL` or `''` for the default time zone or a single string with time zone identifier, see `stri_timezone_list`
`locale` | `NULL` or `''` for the current default locale, or a single string with a locale identifier; a non-Gregorian calendar may be specified by setting `@calendar=name` keyword

## Details

Vectorized over `time`.

## Value

Returns a data frame with the following columns:

1. Year (0 is 1BC, -1 is 2BC, etc.)

2. Month (1-based, i.e., 1 stands for the first month, e.g., January; note that the number of months depends on the selected calendar, see `stri_datetime_symbols`)

3. Day

4. Hour (24-h clock)

5. Minute

6. Second

7. Millisecond

8. WeekOfYear (this is locale-dependent)

9. WeekOfMonth (this is locale-dependent)

10. DayOfYear

11. DayOfWeek (1-based, 1 denotes Sunday; see `stri_datetime_symbols`)

12. Hour12 (12-h clock)

13. AmPm (see `stri_datetime_symbols`)

14. Era (see `stri_datetime_symbols`)

## 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_create()`, `stri_datetime_format()`, `stri_datetime_fstr()`, `stri_datetime_now()`, `stri_datetime_symbols()`, `stri_timezone_get()`, `stri_timezone_info()`, `stri_timezone_list()`

## Examples

    stri_datetime_fields(stri_datetime_now())
    ##   Year Month Day Hour Minute Second Millisecond WeekOfYear WeekOfMonth
    ## 1 2024     7  11   12     31      6         108         28           2
    ##   DayOfYear DayOfWeek Hour12 AmPm Era
    ## 1       193         5      0    2   2
    stri_datetime_fields(stri_datetime_now(), locale='@calendar=hebrew')
    ##   Year Month Day Hour Minute Second Millisecond WeekOfYear WeekOfMonth
    ## 1 5784    11   5   12     31      6         113         44           2
    ##   DayOfYear DayOfWeek Hour12 AmPm Era
    ## 1       300         5      0    2   1
    stri_datetime_symbols(locale='@calendar=hebrew')$Month[
       stri_datetime_fields(stri_datetime_now(), locale='@calendar=hebrew')$Month
    ]
    ## [1] "Tamuz"