Skip to content

Commit 82a76a7

Browse files
author
hagan
committed
fixed errors in description
1 parent 8a59078 commit 82a76a7

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

R/methods.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ calculate <- S7::new_generic("calculate","x")
1717
#' @returns dbi object
1818
#' @export
1919
#' @description
20-
#' `create_calendar()` summarizes a tibble to target time unit and completes the calendar to ensure
20+
#' [create_calendar()] summarizes a tibble to target time unit and completes the calendar to ensure
2121
#' no missing days, month, quarter or years. If a grouped tibble is passed through it will complete the calendar
2222
#' for each combination of the group
2323
#' @details

R/time_intelligence_classes.R

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,9 @@ qoqtd <- function(.data,.date,.value,calendar_type,lag_n){
442442
#' @name qtdopq
443443
#' @inheritParams pytd
444444
#' @description
445-
#' A short description...
445+
#' - This calculates the quarterly cumulative sum of a targeted value and compares it with the previous full quarter's total value respecting
446+
#' any groups that are passed through with [dplyr::group_by()]
447+
#' - Use [calculate] to return the results
446448
#' @inherit ytd details
447449
#' @family time_intelligence
448450
#' @returns ti object
@@ -489,7 +491,9 @@ qtdopq <- function(.data,.date,.value,calendar_type,lag_n=1){
489491
#' @title Current full period quarter over previous full period quarter
490492
#' @name qoq
491493
#' @description
492-
#' A short description...
494+
#' - This calculates the full quarter value compared to the previous quarter value respecting
495+
#' any groups that are passed through with [dplyr::group_by()]
496+
#' - Use [calculate] to return the results
493497
#'
494498
#' @inheritParams pytd
495499
#' @family time_intelligence
@@ -890,7 +894,7 @@ pwtd <- function(.data,.date,.value,calendar_type,lag_n){
890894

891895

892896

893-
#' @title Current period Wwek-to-date over previous period week-to-date
897+
#' @title Current period Week-to-date over previous period week-to-date
894898
#' @name wowtd
895899
#' @inheritParams pytd
896900
#' @description

0 commit comments

Comments
 (0)