Skip to content

Added format specifier for yearqtr #7713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LunaticSage218 wants to merge 6 commits into
base: master
Choose a base branch
from
+24 −3
Open

Added format specifier for yearqtr #7713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8adf4eb
Added format specifier for issue #7694
LunaticSage218 Apr 20, 2026
3ed57e1
Added format specifier in yearqtr for issue #7694
LunaticSage218 Apr 20, 2026
a8287ac
Added format specifier for yearqtr #7694
LunaticSage218 Apr 20, 2026
9e531a3
Added documentation for yearqtr changes
LunaticSage218 Apr 21, 2026
8c045f7
Update man/IDateTime.Rd
LunaticSage218 Apr 21, 2026
c325bee
Optimized yearqtr formatting and fixed doc typos
LunaticSage218 Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@

9. `fread()` no longer replaces a literal header column name `"NA"` with an auto-generated `Vn` name when `na.strings` includes `"NA"`, [#5124](https://github.com/Rdatatable/data.table/issues/5124). Data rows still continue to parse `"NA"` as missing. Thanks @Mashin6 for the report and @shrektan for the fix.

10. `yearqtr()` gains an optional `format` argument [#7694](https://github.com/Rdatatable/data.table/issues/7694). 'numeric' is the default and preserves the original behavior, while 'character' formats the date as YYYYQ# (e.g., 2025Q2). Thanks to @jan-swissre for the report and @LunaticSage218 for the implementation.

### Notes

1. {data.table} now depends on R 3.5.0 (2018).
Expand Down
12 changes: 11 additions & 1 deletion R/IDateTime.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,17 @@ month = function(x) convertDate(as.IDate(x), "month")
quarter = function(x) convertDate(as.IDate(x), "quarter")
year = function(x) convertDate(as.IDate(x), "year")
yearmon = function(x) convertDate(as.IDate(x), "yearmon")
yearqtr = function(x) convertDate(as.IDate(x), "yearqtr")
yearqtr = function(x, format=c("numeric", "character")) {
format = match.arg(format)
x_as_idate = as.IDate(x)
yqtr = convertDate(x_as_idate, "yearqtr")
if (format == "numeric") return(yqtr)
yr = floor(yqtr)
qtr = round((yqtr - yr) * 4) + 1L
ans = paste0(yr, "Q", qtr)
Copy link
Copy Markdown
Member

@jangorecki jangorecki Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would go with allocating NA vector first, and then filling up non-NA, less input to paste, which needs to populate global string cache on each string.

ans[is.na(x_as_idate)] = NA_character_
ans
}

convertDate = function(x, type) {
type = match.arg(type, c("yday", "wday", "mday", "week", "month", "quarter", "year", "yearmon", "yearqtr"))
Expand Down
9 changes: 9 additions & 0 deletions inst/tests/tests.Rraw
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21585,3 +21585,12 @@ close(con)
file.create(f <- tempfile())
test(2367.6, fread(file(f)), data.table(), warning="Connection has size 0.")
unlink(f)

# yearqtr() could optionally output 2025Q4 format #7694
x = c("1111-11-11", "2019-01-01", "2019-02-28", "2019-03-01", "2019-12-31", "2020-02-29", "2020-03-01", "2020-12-31", "2040-01-01", "2040-12-31", "2100-03-01", NA)
test(2368.1, yearqtr(x, format="numeric"), c(1111.75, 2019, 2019, 2019, 2019.75, 2020, 2020, 2020.75, 2040, 2040.75, 2100, NA))
test(2368.2, yearqtr(x, format="numeric"), yearqtr(x)) # numeric is the default, preserves backwards compatibility
test(2368.3, yearqtr(x, format="character"), c("1111Q4", "2019Q1", "2019Q1", "2019Q1", "2019Q4", "2020Q1", "2020Q1", "2020Q4", "2040Q1", "2040Q4", "2100Q1", NA_character_))
test(2368.4, yearqtr("2016-08-03 01:02:03.45", format="character"), "2016Q3")
test(2368.5, yearqtr(NA, format="character"), NA_character_)
test(2368.6, yearqtr(x, format="invalid"), error="should be one of")
Copy link
Copy Markdown
Member

@ben-schwen ben-schwen Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pls delete test case 6, since you are essentially testing for the R error message of match.arg, which is beyond our control

4 changes: 2 additions & 2 deletions man/IDateTime.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,7 @@ month(x)
quarter(x)
year(x)
yearmon(x)
yearqtr(x)

yearqtr(x, format = c("numeric", "character"))
Copy link
Copy Markdown
Member

@ben-schwen ben-schwen Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
yearqtr(x, format = c("numeric", "character"))
yearqtr(x, format = c("numeric", "character"))

reinstate deletion of missing line

}

\arguments{
Expand All @@ -115,6 +114,7 @@ yearqtr(x)
the S3 generic.}
\item{units}{one of the units listed for truncating. May be abbreviated.}
\item{ms}{ For \code{as.ITime} methods, what should be done with sub-second fractions of input? Valid values are \code{'truncate'} (floor), \code{'nearest'} (round), and \code{'ceil'} (ceiling). See Details. }
\item{format}{format is either \code{"numeric"} (default) or \code{"character"}. \code{"character"} formats the result as \code{"2025Q4"}.}
}
\details{
\code{IDate} is a date class derived from \code{Date}. It has the same
Expand Down
Loading