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

Reproducibility - Chunks vignette (basics) #2

Closed
Tracked by #12
nikolas-burkoff opened this issue Feb 2, 2022 · 2 comments · Fixed by #21
Closed
Tracked by #12

Reproducibility - Chunks vignette (basics) #2

nikolas-burkoff opened this issue Feb 2, 2022 · 2 comments · Fixed by #21

Comments

@nikolas-burkoff
Copy link
Contributor

nikolas-burkoff commented Feb 2, 2022

The content of agile-R chunks documentation should be transferred (and edited!) into a vignette.

The vignettes should focus on people using chunks (i.e. module developers) and I propose splitting this into a basics and a more complex vignette

The content should include:

  • Why reproducibility is (or can be...) important and that chunks provide a mechanism to allow reproducibility outside of a reactive shiny app
  • How teal handles reproducibility of dataset and pre-processing
  • High level description of chunks
  • Step-by-step guide to adding chunks into a simple module
  • How the show r code shiny module can then be added to allow your app users to view the reproducible code

EDIT: As the concept of chunks is complicated for users, we agreed with @nikolas-burkoff to have the basic vignette as a detailed explanation of the chunks concept, methods, step by step to use these methods, implicit/explicit usage. The advanced vignette will hold the shiny and teal apps (could be in separate vignettes as well) as well as the chunks tricks.

@gogonzo
Copy link
Contributor

gogonzo commented Mar 29, 2022

This one can be named as "teal.code getting started"

@gogonzo gogonzo transferred this issue from another repository Mar 29, 2022
@nikolas-burkoff
Copy link
Contributor Author

hmm - so a lot of the information above refers to modules and things in teal not things in teal.code so we may need to have the teal.code only stuff in a vignette in teal.code and the stuff referring to teal in a vignette in teal...

@mhallal1 mhallal1 self-assigned this Apr 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants