Skip to content

[DOC] Centralize and clarify documentation on mutation, compactification, and other footguns #444

Closed
@dshemetov

Description

@dshemetov

There are a number of gotchas and footguns available for our users. We want to warn them, but we shouldn't overload them. Let's write a "cautions" document and link to that in the rest of the documentation.

Some previous ideas:

  • It's generally unsafe for a user to modify epi_archive internals on their own. Use epiprocess functions whenever possible. epi_archive$clobberable_versions_start <- ... will not go through validation like it does on construction. Same goes for all the other attributes.
  • Partial attribute matching can occur: archive_cases_dv_subset$version will partial match to archive_cases_dv_subset$versions_end.
  • Maybe a "For data.table users:" section. "Reseating" (not sure what this means)
  • see the "Compactify" doc section after wip feat: replace R6 epi_archive with S3 implementation #431 is merged

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions