as_month | R Documentation |
as_month()
is a generic for coercing input in to <grates_month>
.
as_month(x, n, ...)
## Default S3 method:
as_month(x, n, ...)
## S3 method for class 'Date'
as_month(x, n, ...)
## S3 method for class 'POSIXt'
as_month(x, n, ...)
## S3 method for class 'character'
as_month(x, n, ...)
## S3 method for class 'factor'
as_month(x, n, ...)
x |
An R object. Character input is first parsed using POSIXt inputs are converted with the timezone respected. |
n |
Number of months that are being grouped. Must be greater than 1 (use
|
... |
Only used For character input where additional arguments are passed through
to |
A <grates_month>
object.
Internally grates_month
objects are stored as the position, starting at 0,
of n-month groups since the Unix Epoch (1970-01-01). Here n-months is taken
to mean a 'grouping of n consecutive months'. Precision is only to the month
level (i.e. the day of the month is always dropped).
The algorithm to convert between dates and months relative to the UNIX Epoch comes from the work of Davis Vaughan in the unreleased datea package.
as.Date()
as_month("2019-05-03", n = 4L)
as_month(as.POSIXct("2019-03-04 01:01:01", tz = "America/New_York"), n = 2)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.