format_yq {dint}R Documentation

Coerce and Format to Year-Quarter Strings

Description

Coerce and Format to Year-Quarter Strings

Usage

format_yq(x, q = NULL, format = "%Y-Q%q")

Arguments

x, q

Two integer (vectors). q is optional and the interpretation of x will depend on whether q is supplied or not:

  • if only x is supplied, x will be passed to as_date_yq() (e.g. x = 20161 means first quarter of 2016)

  • if x and q are supplied, x is interpreted as year and q as quarter.

format

A format that uses a subset of the same placeholders as base::strptime():

⁠%Y⁠ Year with century (the full year)
⁠%y⁠ Year without century (the last two digits of the year)
⁠%m⁠ Month as a decimal numbers (01-12)
⁠%B⁠ Full month name
⁠%b⁠ Abbreviated month name
⁠%V⁠ Week of the year as decimal number (01-53) as defined in ISO8601

Not all placeholders are supported for all date_xx subclasses. Literal "%" can be escaped with "%%" (as in base::sprintf()).

Value

a character vector

Formatting shorthands

Format shorthand functions in the form of ⁠format_y*_[preset]()⁠ directly apply formatting presets to anything that can be coerced to a date_xx. This is notably handy as they can be used as a labeling function for ggplot2 axes (see vignette("dint"))

See Also

format.date_yq()

Other coerce and format functions: format_ym(), format_yw()

Examples


format_yq(2015, 1)
format_yq(20151, format = "short")
format_yq(20151, format = "shorter")


[Package dint version 2.1.3 Index]