[go: up one dir, main page]

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

Updating transmissibility template #144

Merged
merged 75 commits into from
May 28, 2024
Merged

Updating transmissibility template #144

merged 75 commits into from
May 28, 2024

Conversation

CarmenTamayo
Copy link
Contributor
@CarmenTamayo CarmenTamayo commented Apr 12, 2024

Changes in this branch:
 

  • Overall, making changes to the text so it addresses the external reader of the report rather than the user of the package Changing content of the output of episoap templates #120
  • A brief description of what each chunk of code is doing has been included as well, addressing mainly the user of the package, to facilitate the process if they decide to make any changes to the template
  • Added missing information about the explanation for the different methods used to estimate Rt, to standardise the content of the rmd chunks Missing info in EpiNow2 chunk #141
  • Updated description of some report parameters (incomplete_days r_estim_window, data_file)
  • Changed description from "This report provides a template for estimating tx" to "This report estimates disease tx" since this is what the reader will see (a report rather than a template, which is seen by the user instead)
  • Provided description of types of file that are suitable as input data Allowed input file types for {episoap}? #146
  • Moving instructions about the code from main text of the report to rmd chunks (e.g., info about which packages need to be loaded, instructions on how to change input data)
  • Swapping description of example data (COVID-19 hospitalisations in the UK in 2020) to a template so that users can describe their own data to match the outputs of the report.
  • Correcting name of dataset from "dat" to "dat_raw"
  • Updating the description of the dataset used as input data so that it contains only the variables needed for the analysis (date/region/incidence), and allowing users to input their own description of these variables.
  • Adding chunk of code to visualise the heading of this dataset
  • Adding code to plot global epicurve before stratified epicurves
  • Serial interval
  • Updated use of incidence2 (interval from "daily" to 1L)
  • EpiNow2

CarmenTamayo and others added 26 commits April 26, 2024 11:35
… provided mean/sd and when these are obtained from {epiparameter}
…es so it's understandable by external readers
…stimates for days defined by "r_estim_window"
Copy link
Member
@Bisaloo Bisaloo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

I browsed through the changes and it looks all good to me. Only comment is that I wouldn't put include = FALSE on any chunks.
In my opinion, we should display or hide all chunks, not just some of them.

I confirm the reports render without issues on my local computer.

@codecov-commenter
Copy link
codecov-commenter commented May 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 30.00%. Comparing base (a44eda5) to head (7508c47).
Report is 15 commits behind head on main.

Current head 7508c47 differs from pull request most recent head c2dcaf9

Please upload reports for the commit c2dcaf9 to get more accurate results.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #144       +/-   ##
===========================================
- Coverage   73.07%   30.00%   -43.08%     
===========================================
  Files           4        3        -1     
  Lines          26       10       -16     
===========================================
- Hits           19        3       -16     
  Misses          7        7               

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…piNow2.Rmd

Co-authored-by: Hugo Gruson <10783929+Bisaloo@users.noreply.github.com>
@CarmenTamayo CarmenTamayo merged commit 90ff4c6 into main May 28, 2024
8 checks passed
@CarmenTamayo CarmenTamayo deleted the Tx_pipeline_update branch May 28, 2024 09: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.

3 participants