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

Remove basic plotting sections in vignettes #65

Closed
pratikunterwegs opened this issue Jul 31, 2023 · 2 comments
Closed

Remove basic plotting sections in vignettes #65

pratikunterwegs opened this issue Jul 31, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@pratikunterwegs
Copy link
Collaborator

I'm wondering about adding these [plotting] sections that are about plotting the data prior to applying the functions, it's nice but maybe the content of the vignettes should go a bit more straight to the point of demonstrating the functionality of the package and the plotting that's not showcasing the outputs of the functions would fit better on a tutorial or learning platform like Applied Epi?

Originally posted by @CarmenTamayo in #55 (comment)

@pratikunterwegs pratikunterwegs self-assigned this Aug 3, 2023
@pratikunterwegs pratikunterwegs added the documentation Improvements or additions to documentation label Aug 3, 2023
@jamesmbaazam
Copy link
Member

Thanks, @CarmenTamayo, you have a valid point. I think just plotting the data without any form of discussion could make the plots look out of place. It's interesting because it is similar to viewing the "head" of the data in most vignettes. Why does the former look out of place? (just thinking out loud).

Generally, data analysis good practice dictates first exploring the data (viewing the head, plotting it, etc.). I am not totally convinced that plotting the data in our vignettes to explore it before applying the package's functionality is necessarily bad. I think if anything, it establishes good practice. The only thing I would suggest here is to add a few statements about what the data looks like and why it is suitable for the purpose.

@pratikunterwegs
Copy link
Collaborator Author

Fixed in #104

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants