|
28 | 28 | #' The data table `DT` has key variables `geo_value`, `time_value`, `version`, |
29 | 29 | #' as well as any others (these can be specified when instantiating the |
30 | 30 | #' `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 |
32 | 34 | #' key variables, and thus the key variables are critical for figuring out how |
33 | 35 | #' to generate a snapshot of data from the archive, as of a given version. |
34 | | -#' |
| 36 | +#' |
35 | 37 | #' In general, last observation carried forward (LOCF) is used to data in |
36 | 38 | #' between recorded versions. Currently, deletions must be represented as |
37 | 39 | #' revising a row to a special state (e.g., making the entries `NA` or |
@@ -117,6 +119,10 @@ epi_archive = |
117 | 119 | #' fields; named entries from the passed list or will be included as well. |
118 | 120 | #' @return An `epi_archive` object. |
119 | 121 | #' @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. |
120 | 126 | initialize = function(x, geo_type, time_type, other_keys, |
121 | 127 | additional_metadata) { |
122 | 128 | # Check that we have a data frame |
|
0 commit comments