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

Referring to template parameters in the text of the transmissibility report #140

Closed
CarmenTamayo opened this issue Apr 9, 2024 · 1 comment
Assignees

Comments

@CarmenTamayo
Copy link
Contributor

On the text of the transmissibility report, which is meant to be rendered and read by external people, who haven't necessarily been involved in developing the reports, there are often references to the parameters that are listed at the start of the template. For instance, in the EpiNow2 chunk, it currently says "a table summarising these results for the last r params$r_estim_window days"
However the external readers that haven't been involved in creating the report and are unfamiliarised with the package will have no idea what this is referring to.
For this reason I propose changing these to describing what those parameters mean and, when relevant, mentioning them inside the code chunks instead, as well as in the documentation of the package.
This will be addressed in the branch "tx_pipeline_update"

@CarmenTamayo
Copy link
Contributor Author

This has been addressed in #144

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

No branches or pull requests

1 participant