Skip to content

Commit

Permalink
[#682] Clarify the documentation of type param of quarter()
Browse files Browse the repository at this point in the history
  • Loading branch information
vspinu committed Jul 20, 2023
1 parent 11d1c9a commit cae67ea
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
9 changes: 5 additions & 4 deletions R/accessors-quarter.r
Expand Up @@ -9,10 +9,11 @@ NULL
#' zoo, zooreg, timeDate, xts, its, ti, jul, timeSeries, fts or anything else that can
#' be converted with as.POSIXlt
#' @param type the format to be returned for the quarter. Can be one one of "quarter" -
#' return numeric quarter (default), "year.quarter" - return fractional numeric
#' year.quarter, "date_first" or "date_last" - return the date at the quarter's start
#' or end, "year_start/end" - return a full description of the quarter as a string
#' which includes the start and end of the year (ex. "2020/21 Q1").
#' return numeric quarter (default), "year.quarter" return the ending year and quarter
#' as a number of the form year.quarter, "date_first" or "date_last" - return the date
#' at the quarter's start or end, "year_start/end" - return a full description of the
#' quarter as a string which includes the start and end of the year
#' (ex. "2020/21 Q1").
#' @param fiscal_start numeric indicating the starting month of a fiscal year.
#' @param with_year logical indicating whether or not to include the quarter or
#' semester's year (deprecated; use the `type` parameter instead).
Expand Down
9 changes: 5 additions & 4 deletions man/quarter.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit cae67ea

Please sign in to comment.