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

Update documentation for specific models #398

Closed
athowes opened this issue Oct 21, 2024 · 0 comments · Fixed by #447
Closed

Update documentation for specific models #398

athowes opened this issue Oct 21, 2024 · 0 comments · Fixed by #447
Assignees
Labels
high Required for next release

Comments

@athowes
Copy link
Collaborator

athowes commented Oct 21, 2024

After we have the preprocessing interface solidified, we should go back and make sure that the models we have are documented well taking that preprocessing into account.

For example right now:

#' Prepare latent individual model
#'
#' @param data A `data.frame` containing line list data
#' @family latent_individual
#' @export
as_latent_individual <- function(data) {
  UseMethod("as_latent_individual")
}

I was going to replace data here with an @inheritParam from somehwere, but really this data should be a different kind of parameter. One that is before the processing. Perhaps it should say "an object created using as_linelist() (or another constructor).

Another example issue:

#' Define the model-specific component of an `epidist` custom formula
#'
#' @param data A `data.frame` containing line list data
#' @param formula As produced by [brms::brmsformula()]
#' @param ... ...
#' @method epidist_formula_model epidist_latent_individual
#' @family latent_individual
#' @export
epidist_formula_model.epidist_latent_individual <- function(
  data, formula, ...
) {
  # data is only used to dispatch on
  formula <- stats::update(
    formula, delay | vreal(relative_obs_time, pwindow, swindow) ~ .
  )
  return(formula)
}

This shouldn't say formula as produced by brms::brmsformula() since it needs to have been run through epidist_formula. How to do this and share the argument nicely?

We also need to do this for the direct / pass through model of PR #393.

@athowes athowes added the high Required for next release label Oct 21, 2024
@athowes athowes self-assigned this Nov 13, 2024
seabbs pushed a commit that referenced this issue Jan 10, 2025
Former-commit-id: ee513305330258beecd47163a789c1da54c078f5 [formerly 82b2265ed2043defc9fd66ea6e13be8f69483a18]
Former-commit-id: 46146b8e49d2bb702e4f5499c159b2d41bee6c28
seabbs pushed a commit that referenced this issue Jan 21, 2025
Former-commit-id: 153b4cc
Former-commit-id: 33fcff9ac2587e72eb23a295752227e4c097d7b1
seabbs pushed a commit that referenced this issue Jan 21, 2025
Former-commit-id: 153b4cc
Former-commit-id: 33fcff9ac2587e72eb23a295752227e4c097d7b1
seabbs pushed a commit that referenced this issue Jan 21, 2025
Former-commit-id: 153b4cc
Former-commit-id: 33fcff9ac2587e72eb23a295752227e4c097d7b1
seabbs pushed a commit that referenced this issue Jan 21, 2025
Former-commit-id: ee513305330258beecd47163a789c1da54c078f5 [formerly 82b2265ed2043defc9fd66ea6e13be8f69483a18]
Former-commit-id: 46146b8e49d2bb702e4f5499c159b2d41bee6c28
seabbs pushed a commit that referenced this issue Jan 21, 2025
Former-commit-id: ee513305330258beecd47163a789c1da54c078f5 [formerly 82b2265ed2043defc9fd66ea6e13be8f69483a18]
Former-commit-id: 46146b8e49d2bb702e4f5499c159b2d41bee6c28
Former-commit-id: 1ab2904
seabbs pushed a commit that referenced this issue Jan 21, 2025
Former-commit-id: 153b4cc
Former-commit-id: 33fcff9ac2587e72eb23a295752227e4c097d7b1
Former-commit-id: 760234bf1efab51aa78e7b1bad96050f4ba9e595 [formerly bff4513]
Former-commit-id: 8eb18339f9980fc1e9559aed3a766991c7425c99
seabbs pushed a commit that referenced this issue Jan 21, 2025
Former-commit-id: 153b4cc
Former-commit-id: 33fcff9ac2587e72eb23a295752227e4c097d7b1
Former-commit-id: 760234bf1efab51aa78e7b1bad96050f4ba9e595 [formerly bff4513]
Former-commit-id: 8eb18339f9980fc1e9559aed3a766991c7425c99
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
high Required for next release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant