as_ymon: Coerce to year month

In DavisVaughan/datea: Extended Date Classes

Description

• Date, POSIXct, and POSIXlt are converted directly by extracting the year and month from x. Any day, hour, minute, or second components are dropped. Time zone information is not retained.

• Integer and double input are assumed to be the number of months since the Unix origin of 1970-01-01.

• Character input is assumed to be provided in a format containing only information about the year and month, such as "1970-01" or "Jan 1970". It is parsed using the defaults of ymon_parse().

Usage

as_ymon(x, ...)

## S3 method for class 'Date'
as_ymon(x, ...)

## S3 method for class 'POSIXct'
as_ymon(x, ...)

## S3 method for class 'POSIXlt'
as_ymon(x, ...)

## S3 method for class 'integer'
as_ymon(x, ...)

## S3 method for class 'double'
as_ymon(x, ...)

## S3 method for class 'character'
as_ymon(x, ...)

Arguments

x	[vector] An object to coerce to ymon.
...	Not used.

Examples

# Extra information such as days, hours, or time zones are dropped
as_ymon(as.Date("2019-05-03"))
as_ymon(as.POSIXct("2019-03-04 01:01:01", tz = "America/New_York"))

# Integers are interpreted as the number of months since 1970-01-01
as_ymon(0L)
as_ymon(12L)

DavisVaughan/datea documentation built on April 10, 2020, 12:03 a.m.