lubridate (version 1.2.0)

ymd: Parse dates according to the order that year, month, and day elements appear in the input vector.

Description

Transforms dates stored in character and numeric vectors to POSIXct objects. These functions recognize arbitrary non-digit separators as well as no separator. As long as the order of formats is correct, these functions will parse dates correctly even when the input vectors contain differently formatted dates. See examples. For even more flexibility in treatment of heterogeneous formats see low level parser parse_date_time.

Usage

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

Arguments

...
a character or numeric vector of suspected dates
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. Number of formats that can be truncated.

Value

  • a vector of class POSIXct

Details

ymd family of functions automatically assign the Universal Coordinated Time Zone (UTC) to the parsed dates. This time zone can be changed with force_tz.

If truncated parameter is non-zero ymd functions also check for truncated formats. For example ymd with truncated = 2 will also parse incomplete dates like 2012-06 and 2012.

NOTE: ymd family of functions are based on strptime which currently correctly parses "%y" format, but fails to parse "%y-%m" formats.

See Also

parse_date_time for underlying mechanism.

Examples

Run this code
x <- c("09-01-01", "09-01-02", "09-01-03")
ymd(x)
## "2009-01-01 UTC" "2009-01-02 UTC" "2009-01-03 UTC"
x <- c("2009-01-01", "2009-01-02", "2009-01-03")
ymd(x)
## "2009-01-01 UTC" "2009-01-02 UTC" "2009-01-03 UTC"
ymd(090101, 90102)
## "2009-01-01 UTC" "2009-01-02 UTC"
now() > ymd(20090101)
## TRUE
dmy(010210)
mdy(010210)

## heterogenuous formats in a single vector:
x <- c(20090101, "2009-01-02", "2009 01 03", "2009-1-4",
       "2009-1, 5", "Created on 2009 1 6", "200901 !!! 07")
ymd(x)

## 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:
ymd("201002-01", "201002-1", "20102-1")
dmy("0312-2010", "312-2010")

Run the code above in your browser using DataCamp Workspace