Skip to content

Change expected type of reported_cases argument to numeric #594

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

Merged
merged 5 commits into from
Mar 4, 2024

Conversation

jamesmbaazam
Copy link
Contributor

Description

This PR closes #506.

The previous documentation mentioned that the reported_cases argument and confirm column in the obs argument of estimate_truncation should be an integer. However, the type should/can be numeric (more relaxed), so the documentation has been updated.

The current checks on the relevant columns and observations already capture this behaviour.

Initial submission checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have tested my changes locally (using devtools::test() and devtools::check()).
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required and rebuilt docs if yes (using devtools::document()).
  • I have followed the established coding standards (and checked using lintr::lint_package()).
  • I have added a news item linked to this PR.

After the initial Pull Request

  • I have reviewed Checks for this PR and addressed any issues as far as I am able.

sbfnk
sbfnk previously approved these changes Mar 4, 2024
@sbfnk sbfnk enabled auto-merge (squash) March 4, 2024 15:22
jamesmbaazam and others added 2 commits March 4, 2024 15:55
Co-authored-by: Sebastian Funk <sebastian.funk@lshtm.ac.uk>
sbfnk
sbfnk previously approved these changes Mar 4, 2024
@sbfnk sbfnk merged commit c5f2437 into main Mar 4, 2024
@sbfnk sbfnk deleted the improve-reported-cases-doc branch March 4, 2024 18:32
sbfnk pushed a commit that referenced this pull request May 3, 2024
* Revise doc to state expected type as numeric not integer

* Add NEWS item
sbfnk pushed a commit that referenced this pull request May 3, 2024
* Revise doc to state expected type as numeric not integer

* Add NEWS item
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.

Documentation of reported_cases should not refer to integers
2 participants