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

Teal how-to series #15

Closed
asbates opened this issue Mar 28, 2023 · 3 comments
Closed

Teal how-to series #15

asbates opened this issue Mar 28, 2023 · 3 comments
Labels
core documentation Improvements or additions to documentation

Comments

@asbates
Copy link

asbates commented Mar 28, 2023

Not sure if we would want to do this as part of CRAN release so I put this in a new issue.

I'm thinking it could be helpful to have a series of tutorials on teal. Starting with the bare minimum. Then add quenv, then reporter, then ... I know we kind of have this with vignettes but there's not a clear order and not a clear build up.

Maybe this could be a bookdown or even a video series.

@lcd2yyz lcd2yyz added documentation Improvements or additions to documentation core labels Mar 28, 2023
@asbates
Copy link
Author

asbates commented Mar 29, 2023

A couple of ideas on how this could go.

Start with the absolute simplest example of a teal application. The next section would then introduce teal.code and qenv through an example app, adding it to the original simple application. Then teal.slice and the filtering could be introduced, again adding it to the original application, but not including the teal.code parts from the second example. The idea here is that features are introduced independently, one at a time. This would be more of a reference guide that people could go to when they want to learn about a particular feature.

The next idea is having an end goal application that gets slowly built up. This could be a complex example with multiple modules, reporting, etc. We could show the app first allowing people to see what the goal is. Then each lesson builds on the last, working our way up to the final application.

@donyunardi
Copy link
Collaborator

This issue felt very similar with what we're trying to achieve in insightsengineering/teal#807

We'll make sure to include the topic of creating shiny module where qenv and reporter topics will be covered.

@donyunardi
Copy link
Collaborator

Closing, duplicate of insightsengineering/teal#807

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

No branches or pull requests

3 participants