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

Clearer deliniation illustrative and live vignette code #165

Open
athowes opened this issue Apr 19, 2024 · 0 comments
Open

Clearer deliniation illustrative and live vignette code #165

athowes opened this issue Apr 19, 2024 · 0 comments

Comments

@athowes
Copy link

athowes commented Apr 19, 2024

Hi! Have just been reading through the EpiEstim Vignette to learn about the package.

One thing that I thought could help make things clearer is to make it quite obvious which code snippets are just there for illustrative purposes, and which can be run by someone working through the vignette to generate the displayed outputs.

It would also be nice in the sections that the user should be able to run to make it easier for them by having all code availabe. For example within Example A: Entire Workflow loading the data could be added to the displayed code.

Note: perhaps this is just my preference, as I like to try to code along while reading, and to others it matters less!

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