ymd_hms {lubridate} | R Documentation

## Parse date-times with year, month, and day, hour, minute, and second components.

### Description

Transform dates stored as character or numeric vectors to POSIXct objects. ymd_hms family of functions recognize all non-alphanumeric separators (with the exception of "." if `frac = TRUE`) and correctly handle heterogeneous date-time representations. For more flexibility in treatment of heterogeneous formats, see low level parser `parse_date_time()`.

### Usage

    ymd_hms(..., quiet = FALSE, tz = "UTC", locale = Sys.getlocale("LC_TIME"),
      truncated = 0)

    ymd_hm(..., quiet = FALSE, tz = "UTC", locale = Sys.getlocale("LC_TIME"),
      truncated = 0)

    ymd_h(..., quiet = FALSE, tz = "UTC", locale = Sys.getlocale("LC_TIME"),
      truncated = 0)

    dmy_hms(..., quiet = FALSE, tz = "UTC", locale = Sys.getlocale("LC_TIME"),
      truncated = 0)

    dmy_hm(..., quiet = FALSE, tz = "UTC", locale = Sys.getlocale("LC_TIME"),
      truncated = 0)

    dmy_h(..., quiet = FALSE, tz = "UTC", locale = Sys.getlocale("LC_TIME"),
      truncated = 0)

    mdy_hms(..., quiet = FALSE, tz = "UTC", locale = Sys.getlocale("LC_TIME"),
      truncated = 0)

    mdy_hm(..., quiet = FALSE, tz = "UTC", locale = Sys.getlocale("LC_TIME"),
      truncated = 0)

    mdy_h(..., quiet = FALSE, tz = "UTC", locale = Sys.getlocale("LC_TIME"),
      truncated = 0)

    ydm_hms(..., quiet = FALSE, tz = "UTC", locale = Sys.getlocale("LC_TIME"),
      truncated = 0)

    ydm_hm(..., quiet = FALSE, tz = "UTC", locale = Sys.getlocale("LC_TIME"),
      truncated = 0)

    ydm_h(..., quiet = FALSE, tz = "UTC", locale = Sys.getlocale("LC_TIME"),
      truncated = 0)

### Arguments

`...` | a character vector of dates in year, month, day, hour, minute, second format
`quiet` | logical. When TRUE function evalueates without displaying customary messages.
`tz` | a character string that specifies which time zone to parse the date with. The string must be a time zone that is recognized by the user's OS.
`locale` | locale to be used, see locales. On linux systems you can use `system("locale -a")` to list all the installed locales.
`truncated` | integer, indicating how many formats can be missing. See details.

### Details

ymd_hms() functions automatically assigns the Universal Coordinated Time Zone (UTC) to the parsed date. This time zone can be changed with `force_tz()`.

The most common type of irregularity in date-time data is the truncation due to rounding or unavailability of the time stamp. If the `truncated` parameter is non-zero, the `ymd_hms` functions also check for truncated formats. For example, `ymd_hms()` with `truncated = 3` will also parse incomplete dates like `2012-06-01 12:23`, `2012-06-01 12` and `2012-06-01`. NOTE: The `ymd` family of functions are based on `strptime()` which currently fails to parse `%y-%m` formats.

In case of heterogeneous date formats `ymd_hms()` family guesses formats based on a sub-set of the input vector. If the input vector contains many missing values or non-date strings, the sub-set might not contain meaningful dates and the date-time format won't be guessed resulting in "All formats failed to parse" error. In such cases please see `parse_date_time()` for a more flexible parsing interface.

As of version 1.3.0, lubridate's parse functions no longer return a message that displays which format they used to parse their input. You can change this by setting the `lubridate.verbose` option to `TRUE` with `options(lubridate.verbose = TRUE)`.

### Value

a vector of POSIXct date-time objects

### See Also

- `ymd()`, `hms()`

- `parse_date_time()` for the underlying mechanism

### Examples

    x <- c("2010-04-14-04-35-59", "2010-04-01-12-00-00")
    ymd_hms(x)
    x <- c("2011-12-31 12:59:59", "2010-01-01 12:00:00")
    ymd_hms(x)

    ## ** heterogenuous formats **
    x <- c(20100101120101, "2009-01-02 12-01-02", "2009.01.03 12:01:03",
           "2009-1-4 12-1-4",
           "2009-1, 5 12:1, 5",
           "200901-08 1201-08",
           "2009 arbitrary 1 non-decimal 6 chars 12 in between 1 !!! 6",
           "OR collapsed formats: 20090107 120107 (as long as prefixed with zeros)",
           "Automatic wday, Thu, detection, 10-01-10 10:01:10 and p format: AM",
           "Created on 10-01-11 at 10:01:11 PM")
    ymd_hms(x)

    ## ** fractional seconds **
    op <- options(digits.secs=3)
    dmy_hms("20/2/06 11:16:16.683")
    options(op)

    ## ** different formats for ISO8601 timezone offset **
    ymd_hms(c("2013-01-24 19:39:07.880-0600",
    "2013-01-24 19:39:07.880", "2013-01-24 19:39:07.880-06:00",
    "2013-01-24 19:39:07.880-06", "2013-01-24 19:39:07.880Z"))

    ## ** internationalization **
    ## Not run:
    x_RO <- "Ma 2012 august 14 11:28:30 "
      ymd_hms(x_RO, locale = "ro_RO.utf8")

    ## End(Not run)

    ## ** truncated time-dates **
    x <- c("2011-12-31 12:59:59", "2010-01-01 12:11", "2010-01-01 12", "2010-01-01")
    ymd_hms(x, truncated = 3)
    x <- c("2011-12-31 12:59", "2010-01-01 12", "2010-01-01")
    ymd_hm(x, truncated = 2)
    ## ** What lubridate might not handle **
    ## Extremely weird cases when one of the separators is "" and some of the
    ## formats are not in double digits might not be parsed correctly:
    ## Not run:
    ymd_hm("20100201 07-01", "20100201 07-1", "20100201 7-01")
    ## End(Not run)

[Package lubridate version 1.7.4 Index]