month: Get/set months component of a date-time

Description Usage Arguments Value Examples

View source: R/accessors-month.r

Description

Date-time must be a POSIXct, POSIXlt, Date, Period, chron, yearmon, yearqtr, zoo, zooreg, timeDate, xts, its, ti, jul, timeSeries, and fts objects.

Usage

1
2
3
month(x, label = FALSE, abbr = TRUE, locale = Sys.getlocale("LC_TIME"))

month(x) <- value

Arguments

x

a date-time object

label

logical. TRUE will display the month as a character string such as "January." FALSE will display the month as a number.

abbr

logical. FALSE will display the month as a character string label, such as "January". TRUE will display an abbreviated version of the label, such as "Jan". abbr is disregarded if label = FALSE.

locale

for month, locale to use for month names. Default to current locale.

value

a numeric object

Value

the months element of x as a number (1-12) or character string. 1 = January.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
x <- ymd("2012-03-26")
month(x)
month(x) <- 1
month(x) <- 13
month(x) > 3

month(ymd(080101))
month(ymd(080101), label = TRUE)
month(ymd(080101), label = TRUE, abbr = FALSE)
month(ymd(080101) + months(0:11), label = TRUE)

Example output

Attaching package: 'lubridate'

The following object is masked from 'package:base':

    date

[1] 3
[1] FALSE
[1] 1
[1] Jan
12 Levels: Jan < Feb < Mar < Apr < May < Jun < Jul < Aug < Sep < ... < Dec
[1] January
12 Levels: January < February < March < April < May < June < ... < December
 [1] Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
12 Levels: Jan < Feb < Mar < Apr < May < Jun < Jul < Aug < Sep < ... < Dec

lubridate documentation built on Nov. 17, 2017, 6:56 a.m.