Skip to content
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.

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

A 'rollforward' function? #914

Closed
kputschko opened this issue Aug 7, 2020 · 4 comments
Closed

A 'rollforward' function? #914

kputschko opened this issue Aug 7, 2020 · 4 comments

Comments

@kputschko
Copy link

kputschko commented Aug 7, 2020

I'm looking for a quicker way to roll a date to the end of the given month. Currently it takes two functions, ceiling_date and subtracting days.

library(lubridate)

date_1 <- ymd("2020-01-15")

# rollback is simple and great
rollback(date_1)
rollback(date_1, roll_to_first = TRUE)

# but rolling forward looks a little clunky
ceiling_date(date_1, unit = "month") - days(1)
>"2020-01-31"

# maybe add an option to rollback?
rollback(date_1, roll_to_last = TRUE)
>"2020-01-31"

# or create a new function?
rollforward(date_1)
>"2020-01-31"
@vspinu
Copy link
Member

vspinu commented Aug 8, 2020

"faster" as in "type faster" or "faster execution speed"?

I think it makes sense to add it for completeness, as a counterpart of rollback.

@seasmith
Copy link

seasmith commented Sep 17, 2020

rollforward <- function (dates, roll_to_first = FALSE, preserve_hms = TRUE) 
{
  if (length(dates) == 0) 
    return(dates)
  day(dates) <- 1
  if (!preserve_hms) {
    hour(dates) <- 0
    minute(dates) <- 0
    second(dates) <- 0
  }
  if (roll_to_first) {
    dates + months(1)
  }
  else {
    dates + months(1) - days(1)
  }
}

@vspinu vspinu closed this as completed in 96b379c Oct 4, 2020
@UweBlock
Copy link

UweBlock commented Feb 28, 2021

Just saw the new function being mentioned in News.md.

For the sake of consistency with rollback(), I had expected

library(lubridate)

date_1 <- ymd("2020-01-15")

rollback(date_1)
# "2019-12-31" = last day of preceeding month

rollforward(date_1)
# "2020-02-01" = first day of succeeding month
#  equivalent to
ceiling_date(date_1, unit = "month")

rollback(date_1, roll_to_first = TRUE)
# "2020-01-01" = first day of given month

rollforward(date_1, roll_to_last = TRUE)
# "2020-01-31" = last day of given month

@vspinu
Copy link
Member

vspinu commented Mar 1, 2021

This is an alternative notion of a symmetry, or probably better asymetry. What you propose is the mirror of rollback.

The advantage of the current design is that there is no extra argument (roll_to_last) and reasoning about the code is simpler because there is one pattern to remember - by default roll to last day, with the argument to first day etc.

netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this issue May 30, 2021
Version 1.7.10
==============

### NEW FEATURES

* `fast_strptime()` and `parse_date_time2()` now accept multiple formats and apply them in turn

### BUG FIXES

* [#926](tidyverse/lubridate#926) Fix incorrect division of intervals by months involving leap years
* Fix incorrect skipping of digits during parsing of the `%z` format

Version 1.7.9.2
===============

### NEW FEATURES

* [#914](tidyverse/lubridate#914) New `rollforward()` function
* [#928](tidyverse/lubridate#928) On startup lubridate now resets TZDIR to a proper directory when it is set to non-dir values like "internal" or "macOS" (a change introduced in R4.0.2)
* [#630](tidyverse/lubridate#630) New parsing functions `ym()` and `my()`

### BUG FIXES

* [#930](tidyverse/lubridate#930) `as.period()` on intervals now returns valid Periods with double fields (not integers)



Version 1.7.9
=============

### NEW FEATURES

* [#871](tidyverse/lubridate#893) Add `vctrs` support


### BUG FIXES

* [#890](tidyverse/lubridate#890) Correctly compute year in `quarter(..., with_year = TRUE)`
* [#893](tidyverse/lubridate#893) Fix incorrect parsing of abbreviated months in locales with trailing dot (regression in v1.7.8)
* [#886](tidyverse/lubridate#886) Fix `with_tz()` for POSIXlt objects
* [#887](tidyverse/lubridate#887) Error on invalid numeric input to `month()`
* [#889](tidyverse/lubridate#889) Export new dmonth function

Version 1.7.8
=============

### NEW FEATURES

* (breaking) Year and month durations now assume 365.25 days in a year consistently in conversion and constructors. Particularly `dyears(1) == years(1)` is now `TRUE`.
* Format and print methods for 0-length objects are more consistent.
* New duration constructor `dmonths()` to complement other duration constructors.
*
* `duration()` constructor now accepts `months` and `years` arguments.
* [#629](tidyverse/lubridate#629) Added `format_ISO8601()` methods.
* [#672](tidyverse/lubridate#672) Eliminate all partial argument matches
* [#674](tidyverse/lubridate#674) `as_date()` now ignores the `tz` argument
* [#675](tidyverse/lubridate#675) `force_tz()`, `with_tz()`, `tz<-` convert dates to date-times
* [#681](tidyverse/lubridate#681) New constants `NA_Date_` and `NA_POSIXct_` which parallel built-in primitive constants.
* [#681](tidyverse/lubridate#681) New constructors `Date()` and `POSIXct()` which parallel built-in primitive constructors.
* [#695](tidyverse/lubridate#695) Durations can now be compared with numeric vectors.
* [#707](tidyverse/lubridate#707) Constructors return 0-length inputs when called with no arguments
* [#713](tidyverse/lubridate#713) (breaking) `as_datetime()` always returns a `POSIXct()`
* [#717](tidyverse/lubridate#717) Common generics are now defined in `generics` dependency package.
* [#719](tidyverse/lubridate#719) Negative Durations are now displayed with leading `-`.
* [#829](tidyverse/lubridate#829) `%within%` throws more meaningful messages when applied on unsupported classes
* [#831](tidyverse/lubridate#831) Changing hour, minute or second of Date object now yields POSIXct.
* [#869](tidyverse/lubridate#869) Propagate NAs to all internal components of a Period object

### BUG FIXES

* [#682](tidyverse/lubridate#682) Fix quarter extraction with small `fiscal_start`s.
* [#703](tidyverse/lubridate#703) `leap_year()` works with objects supported by `year()`.
* [#778](tidyverse/lubridate#778) `duration()/period()/make_difftime()` work with repeated units
* `c.Period` concatenation doesn't fail with empty components.
* Honor `exact = TRUE` argument in `parse_date_time2`, which was so far ignored.

Version 1.7.4
=============

### NEW FEATURES

* [#658](tidyverse/lubridate#658) `%within%` now accepts a list of intervals, in which case an instant is checked if it occurs within any of the supplied intervals.

### CHANGES

* [#661](tidyverse/lubridate#661) Throw error on invalid multi-unit rounding.
* [#633](tidyverse/lubridate#633) `%%` on intervals relies on `%m+` arithmetic and doesn't produce NAs when intermediate computations result in non-existent dates.
* `tz()` always returns "UTC" when `tzone` attribute cannot be inferred.

### BUG FIXES

* [#664](tidyverse/lubridate#664) Fix lookup of period functions in `as.period`
* [#649](tidyverse/lubridate#664) Fix system timezone memoization

Version 1.7.3
=============

### BUG FIXES

* [#643](tidyverse/lubridate#643), [#640](tidyverse/lubridate#640), [#645](tidyverse/lubridate#645) Fix faulty caching of system timezone.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants