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 #4: Setup vignette #5

Merged
merged 26 commits into from
Jan 31, 2025
Merged

Issue #4: Setup vignette #5

merged 26 commits into from
Jan 31, 2025

Conversation

kaitejohnson
Copy link
Collaborator

@kaitejohnson kaitejohnson commented Jan 28, 2025

Description

This PR closes #4.

Here we introduce the Getting Started vignette. We start by using epinowcast package data, which itself uses the truth data from the German hospitalization nowcast hub. It contains daily data indexed by reference date and report date. enw_preprocess_data() is used, and we transform the output of the triangle to a matrix where the rows are the time points and the columns are the delays.

We then use this reporting triangle to estimate the delay. The subsequent sections for applying the delay, estimating the uncertainty, and generating the nowcast are outlined.

Additional tests are required for internal functions, e.g. handle_neg_values() and validate_triangle().

In future versions, we can modify the data we use for the vignette (e.g. another nice place to start might be from visit-level line list data as in https://github.com/kassteele/Nowcasting/blob/master/data/measles_NL_2013_2014.dat)

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.

@kaitejohnson kaitejohnson changed the title 4 setup vignette Issue #4: Setup vignette Jan 29, 2025
Copy link

codecov bot commented Jan 29, 2025

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@kaitejohnson
Copy link
Collaborator Author

@seabbs A little stuck on the linting error (I see the warnings, one is for a global variable and the other falsely thinks a grep is a file path. But exit code 31 is about storage space so not sure.

@kaitejohnson kaitejohnson marked this pull request as ready for review January 30, 2025 17:16
@kaitejohnson kaitejohnson merged commit 9c21a1b into main Jan 31, 2025
7 checks passed
@kaitejohnson kaitejohnson deleted the 4-setup-vignette branch January 31, 2025 11:11
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.

Set up initial problem statement in the vignette
2 participants