Skip to content

Commit a06744e

Browse files
committed
say that other keys has to be a char vector
1 parent 749ce4e commit a06744e

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

R/epi_df.R

+4-4
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ NULL
106106
#' @param additional_metadata List of additional metadata to attach to the
107107
#' `epi_df` object. The metadata will have `geo_type`, `time_type`, and
108108
#' `as_of` fields; named entries from the passed list will be included as
109-
#' well. If your tibble has additional keys, be sure to specify them
110-
#' in the `other_keys` component of `additional_metadata`.
109+
#' well. If your tibble has additional keys, be sure to specify them as a
110+
#' character vector in the `other_keys` component of `additional_metadata`.
111111
#' @param ... Additional arguments passed to methods.
112112
#' @return An `epi_df` object.
113113
#'
@@ -190,8 +190,8 @@ new_epi_df = function(x = tibble::tibble(), geo_type, time_type, as_of,
190190
#' @param additional_metadata List of additional metadata to attach to the
191191
#' `epi_df` object. The metadata will have `geo_type`, `time_type`, and
192192
#' `as_of` fields; named entries from the passed list will be included as
193-
#' well. If your tibble has additional keys, be sure to specify them
194-
#' in the `other_keys` component of `additional_metadata`.
193+
#' well. If your tibble has additional keys, be sure to specify them as a
194+
#' character vector in the `other_keys` component of `additional_metadata`.
195195
#' @param ... Additional arguments passed to methods.
196196
#' @return An `epi_df` object.
197197
#'

man/as_epi_df.Rd

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

man/new_epi_df.Rd

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

0 commit comments

Comments
 (0)