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

Issue #398: Make documentation consistent across models #447

Merged
merged 3 commits into from
Nov 19, 2024

Conversation

athowes
Copy link
Collaborator

@athowes athowes commented Nov 16, 2024

Description

This PR closes #398.

  • Removes documentation mentions of "A data.frame containing line list data." where it's not about the epidist_linelist_data class
  • Trys to more generally describe the inputs to each function
  • Moves a function in the naive_model.R position to be standard with latent_model.R

Note that I don't touch some mentions of "direct" in this PR which are handled by #446.

This PR raised some follow up issues which I have added (#448).

Checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have included the target issue or issues in the PR title in the for Issue(s) issue-numbers: PR title
  • I have read the contribution guidelines.
  • I have tested my changes locally.
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required.
  • My code follows the established coding standards.
  • I have added a news item linked to this PR.
  • I have reviewed CI checks for this PR and addressed them as far as I am able.

R/epidist.R Outdated Show resolved Hide resolved
seabbs
seabbs previously approved these changes Nov 19, 2024
@seabbs seabbs enabled auto-merge (squash) November 19, 2024 10:30
@seabbs seabbs force-pushed the model-documentation branch from 85df7a6 to 87db001 Compare November 19, 2024 10:30
@seabbs seabbs merged commit 153b4cc into main Nov 19, 2024
9 checks passed
@seabbs seabbs deleted the model-documentation branch November 19, 2024 14:01
seabbs pushed a commit that referenced this pull request Jan 10, 2025
Former-commit-id: ee513305330258beecd47163a789c1da54c078f5 [formerly 82b2265ed2043defc9fd66ea6e13be8f69483a18]
Former-commit-id: 46146b8e49d2bb702e4f5499c159b2d41bee6c28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation for specific models
2 participants