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

Ensure doc consistency about explicit/implicit versions in epi_archive #172

Open
brookslogan opened this issue Jul 27, 2022 · 0 comments
Open
Labels
documentation Improvements or additions to documentation P1 medium priority

Comments

@brookslogan
Copy link
Contributor

Currently, some core operations of epi_archive rely on "implicit" versions formed by using the last version of each observation carried forward, rather than an "explicit" listing of every row in every version that we should count as observed. (A user can provide an explicit representation, with some caveats: we will be interpolating between their versions, and they have to use a workaround to represent row deletions.) We are also changing epix_merge from treating the implicit treatment from optional to mandatory. We should make sure the docs reflect this. Checking over docs on main, it looks like we might not be fully consistent about this in the roxygen docs:

  • epi_archive is mixed: DT version column description sounds like explicit, but LOCF paragraph describes implicit.
  • as_of describes implicit
  • epix_slide description is compatible with either, assuming we only allow one.
  • current (pre-Km compactify rectify #101) epix_merge docs confuse the issue, as they describes implicit-like behavior as optional

The vignettes should also be checked to make sure they are accurate.

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 P1 medium priority
Projects
None yet
Development

No branches or pull requests

1 participant