@@ -186,17 +186,21 @@ next_after.Date <- function(x) x + 1L
186
186
# ' archive. Unexpected behavior may result from modifying the metadata
187
187
# ' directly.
188
188
# '
189
- # ' @param data_table a data.table with [`data.table::key()`] equal to
190
- # ' `c("geo_value", other_keys, "time_value", "version")`.
189
+ # ' @param data_table a `data.table` with [`data.table::key()`] equal to
190
+ # ' `c("geo_value", other_keys, "time_value", "version")`. For `data.table`
191
+ # ' users: this sets up an alias of `data_table`; if you plan to keep on
192
+ # ' working with `data_table` or working directly with the archive's `$DT`
193
+ # ' using mutating operations, you should `copy()` if appropriate. We will not
194
+ # ' mutate the `DT` with any exported {epiprocess} functions, though.
191
195
# ' @param geo_type DEPRECATED Has no effect. Geo value type is inferred from the
192
- # ' location column and set to "custom" if not recognized.
193
- # ' @param time_type DEPRECATED Has no effect. Time value type inferred from the time
194
- # ' column and set to "custom" if not recognized. Unpredictable behavior may result
195
- # ' if the time type is not recognized.
196
+ # ' location column and set to "custom" if not recognized.
197
+ # ' @param time_type DEPRECATED Has no effect. Time value type inferred from the
198
+ # ' time column and set to "custom" if not recognized. Unpredictable behavior
199
+ # ' may result if the time type is not recognized.
196
200
# ' @param other_keys Character vector specifying the names of variables in `x`
197
201
# ' that should be considered key variables (in the language of `data.table`)
198
- # ' apart from "geo_value", "time_value", and "version". Typical examples
199
- # ' are "age" or more granular geographies.
202
+ # ' apart from "geo_value", "time_value", and "version". Typical examples are
203
+ # ' "age" or more granular geographies.
200
204
# ' @param compactify Optional; `TRUE`, `FALSE`, or `"message"`. `TRUE` will
201
205
# ' remove some redundant rows, `FALSE` will not. `"message"` is like `TRUE`
202
206
# ' but will emit a message if anything was changed. Default is `TRUE`. See
0 commit comments