PWFSLSmoke (version 1.2.100)

parseDatetime: Parse Datetime Strings

Description

Transforms numeric and string representations of Ymd[HMS] datetimes to POSIXct format.

Ymd, YmdH, YmdHM, and YmdHMS formats are understood, where:

* Y - four digit year * m - decimal number (1-12, 01-12) or english name month (October, oct.) * d - decimal number day of the month (0-31 or 01-31) * H - decimal number hours (0-24 or 00-24) * M - decimal number minutes (0-59 or 00-59) * S - decimal number seconds (0-61 or 00-61)

This allows for mixed inputs. For example, 20181012130900, "2018-10-12-13-09-00", and "2018 Oct. 12 13:09:00" will all be converted to the same POSIXct datetime. The incoming datetime vector does not need to have a homogeneous format either -- "20181012" and "2018-10-12 13:09" can exist in the same vector without issue. All incoming datetimes will be interpreted in the specified timezone.

If datetime is a POSIXct it will be returned unmodified, and formats not recognized will be returned as NA.

Usage

parseDatetime(datetime, timezone = "UTC", expectAll = FALSE)

Arguments

datetime

vector of character or integer datetimes in Ymd[HMS] format (or POSIXct).

timezone

Olson timezone at the location of interest (default "UTC").

expectAll

Logical value determining if the function should fail if any elements fail to parse (default FALSE).

Value

POSIXct datetimes.

PWFSLSmoke Conventions

Within the PWFSLSmoke package, datetimes not in POSIXct format are represented as decimal values with no separation (ex: 20181012, 20181012130900), either as numerics or strings.

Implementation

parseDatetime is essentially a wrapper around parse_date_time, handling which formats we want to account for.

See Also

parse_date_time for implementation details.

Examples

# NOT RUN {
starttime <- parseDatetime(2015080718, timezone = "America/Los_Angeles")
datetimes <- parseDatetime(c("20181014 12", "20181015 12", "20181016 12"))

# }
# NOT RUN {
badInput <- c("20181013", NA, "20181015", "181016", "10172018")

# This will return a vector with the date that were able to parse
parseDatetime(badInput, expectAll = FALSE)

# This will return an error, since some non-NA indices didn't parse
parseDatetime(badInput, expectAll = TRUE)
# }
# NOT RUN {
# }