Skip to content

Commit 28934c1

Browse files
author
admin
committed
Added ref to as_epi_archive in necessary locations
1 parent d9ba16a commit 28934c1

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

R/archive.R

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,12 @@
2828
#' The data table `DT` has key variables `geo_value`, `time_value`, `version`,
2929
#' as well as any others (these can be specified when instantiating the
3030
#' `epi_archive` object via the `other_keys` argument, and/or set by operating
31-
#' on `DT` directly). There can only be a single row per unique combination of
31+
#' on `DT` directly). Refer to the documentation for `as_epi_archive()` for
32+
#' information and examples of relevant parameter names for an `epi_archive` object.
33+
#' Note that there can only be a single row per unique combination of
3234
#' key variables, and thus the key variables are critical for figuring out how
3335
#' to generate a snapshot of data from the archive, as of a given version.
34-
#'
36+
#'
3537
#' In general, last observation carried forward (LOCF) is used to data in
3638
#' between recorded versions. Currently, deletions must be represented as
3739
#' revising a row to a special state (e.g., making the entries `NA` or
@@ -117,6 +119,10 @@ epi_archive =
117119
#' fields; named entries from the passed list or will be included as well.
118120
#' @return An `epi_archive` object.
119121
#' @importFrom data.table as.data.table key setkeyv
122+
#'
123+
#' @details
124+
#' Refer to the documentation for `as_epi_archive()` for more information
125+
#' and examples of parameter names.
120126
initialize = function(x, geo_type, time_type, other_keys,
121127
additional_metadata) {
122128
# Check that we have a data frame

man/epi_archive.Rd

Lines changed: 8 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)