R/demo-data.R

In rjake/headliner: Compose Sentences to Describe Comparisons

#' Small data set referencing the current date
#' @return Returns a data frame of size `n`.
#' @param n number of rows to return
#' @param by string indicating the unit of time between dates in
#' \code{seq.Date(..., by = )}
#' @importFrom tibble tibble
#' @export
#' @examples
#' demo_data()
#'
#' demo_data(n = 8, by = "1 day")
demo_data <- function(n = 10, by = "-2 month") {
  tibble(
    group = rep_len(rep(letters, each = 2), length.out = n),
    sales = 1:n + 100,
    count = n:1 + 25,
    on_sale = 1:n %% 2,
    date = seq.Date(Sys.Date(), length.out = n, by = by)
  )
}