Skip to content

Commit 56d7cb0

Browse files
committed
docs(new_epi_archive): roxygen2 for new param requirements
1 parent 1be9df7 commit 56d7cb0

File tree

3 files changed

+19
-18
lines changed

3 files changed

+19
-18
lines changed

R/archive.R

+4-2
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,8 @@ next_after.Date <- function(x) x + 1L
186186
#' archive. Unexpected behavior may result from modifying the metadata
187187
#' directly.
188188
#'
189-
#' @param x A data.frame, data.table, or tibble, with columns `geo_value`,
190-
#' `time_value`, `version`, and then any additional number of columns.
189+
#' @param data_table a data.table with [`data.table::key()`] equal to
190+
#' `c("geo_value", other_keys, "time_value", "version")`.
191191
#' @param geo_type DEPRECATED Has no effect. Geo value type is inferred from the
192192
#' location column and set to "custom" if not recognized.
193193
#' @param time_type DEPRECATED Has no effect. Time value type inferred from the time
@@ -484,6 +484,8 @@ update_is_locf <- function(arranged_updates_df, ukey_names, abs_tol) {
484484
#' `as_epi_archive` converts a data frame, data table, or tibble into an
485485
#' `epi_archive` object.
486486
#'
487+
#' @param x A data.frame, data.table, or tibble, with columns `geo_value`,
488+
#' `time_value`, `version`, and then any additional number of columns.
487489
#' @param ... used for specifying column names, as in [`dplyr::rename`]. For
488490
#' example `version = release_date`
489491
#' @param .versions_end location based versions_end, used to avoid prefix

man/epi_archive.Rd

+6-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/epi_slide_opt_archive_one_epikey.Rd

+9-13
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)