You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
#' Many API calls accept timesets to specify the time ranges of data being
#' requested. Timesets can be specified with `epirange()`, as `Date` objects, or
#' with wildcards.
#'
#' Timesets are not special R types; the term simply describes any value that
#' would be accepted by epidatr to specify the time value of an epidata query.
#' The allowed values are:
#'
#' - Dates: `Date` instances, integer-like values, or integer-like strings that
#' take the form YYYYMMDD.
#' - Epiweeks: Integer-like values or integer-like strings that take the form
#' YYYYWW.
#' - EpiRanges: A range returned by `epirange()`, or a list of multiple ranges.
#' - Wildcard: The string `"*"`, which request all available time values.
#'
#' Please refer to the specific endpoint documentation for guidance on using
#' dates vs weeks. Most endpoints support only one or the other. Some (less
#' commonly used) endpoints may not accept the `"*"` wildcard, but this can be
#' simulated with a large `epirange()`.
#'
#' @name timeset
This should include an @examples section with examples of various different timesets, with labels saying how they're interpreted.
Since timesets are linked in every API function that takes them as input, this should serve as the primary documentation of how to set dates, instead of deferring to epirange and other things.
The text was updated successfully, but these errors were encountered:
The timeset documentation describes the valid inputs for arguments like
time_values
:epidatr/R/model.R
Lines 65 to 88 in ee952c5
This should include an
@examples
section with examples of various different timesets, with labels saying how they're interpreted.Since timesets are linked in every API function that takes them as input, this should serve as the primary documentation of how to set dates, instead of deferring to epirange and other things.
The text was updated successfully, but these errors were encountered: