Skip to content

"Promote" other_keys to be printed, a constructor parameter, and more clearly documented #186

Closed
@brookslogan

Description

@brookslogan

Migrated from #113 and #183.

  • print.epi_df should print the other_keys metadata.
  • other_keys should be its own parameter to new_epi_df and as_epi_df
  • Unfortunately, I don't think we ever explained what "keys" were in the context of an epi_df, and googling "tibble key" is surprisingly unhelpful (currently giving links to lock picks and decoder tools) [so the {new,as}_epi_df docs may need explication]. Maybe explaining this could just be rolled into the issue for adding other_keys as a parameter, though; it'd be easier to do in its own @param.

If this is causing recurring issues in epipredict maybe it should be changed to higher priority.

Metadata

Metadata

Assignees

No one assigned

    Labels

    REPLImproved print, errors, etc.documentationImprovements or additions to documentationop-semanticsOperational semantics; many potentially breaking changes here

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions