Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix archive additional_metadata docs + maybe rename (or remove?) #396

Open
brookslogan opened this issue Jan 16, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@brookslogan
Copy link
Contributor

Current docs include

#' @param additional_metadata List of additional metadata to attach to the
#'   `epi_archive` object. The metadata will have `geo_type` and `time_type`
#'   fields; named entries from the passed list or will be included as well.

The archive's $additional_metadata doesn't actually get geo & time type attached, but looks like if there are other_keys that they would be put there. If it does have this extra stuff attached, it should be called metadata instead, similar to epi_df. But do we even need an $additional_metadata? Why not just an $other_keys? If users want to attach more metadata, they can just use attr<-; we're not doing anything special/extra.

@brookslogan brookslogan added the documentation Improvements or additions to documentation label Jan 16, 2024
@brookslogan brookslogan added this to the [Idea] Wishlist milestone Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant