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/Teal.data vignette issues #700

Closed
11 tasks done
nikolas-burkoff opened this issue Jul 20, 2022 · 2 comments
Closed
11 tasks done

Teal/Teal.data vignette issues #700

nikolas-burkoff opened this issue Jul 20, 2022 · 2 comments
Assignees
Labels

Comments

@nikolas-burkoff
Copy link
Contributor

nikolas-burkoff commented Jul 20, 2022

We should review the teal and teal.data vignettes and fix them so that there is a coherent set of linked vignettes introducing the data argument of teal::init for new users of the framework the links are here at the moment.

We could move all the vignettes into teal.data and from teal have a link to teal.data for people wanting to learn about the data argument in teal.init. Or we could leave the vignettes needed for teal::init in teal (reference them from teal.data) and then have only the more advanced vignettes in teal.data itself

Note also there is work to make the teal and its vignettes work with data instead of datasets here but that should not interfere with this issue

We should also fix the formatting and outputs - see the pkgdown website for example:

  • Review each of teal vignettes and move the technical details to teal.data and keep only examples in teal:
  • processing data --> moved to teal
  • Input general data in a teal application --> no change
  • Input ADaM data in a teal application --> details on join_keys removed
  • Input MAE data in a teal application --> no change
  • Join keys --> moved to teal
  • Creating custom modules --> no change
  • Adding support for reporting to custom modules --> no change
  • Modifying a teal application with R options --> no change

Additional issues:

  • The "Input ADaM data in a teal application" proceeds to talk all about join_keys for general teal data?

  • Things like this are not helpful:
    image

  • Nor outputs like this:
    image
    image

@nikolas-burkoff
Copy link
Contributor Author

See also #679

@nikolas-burkoff nikolas-burkoff changed the title Pkgdown site issues Teal/Teal.data vignette issues Jul 22, 2022
@mhallal1
Copy link
Collaborator

mhallal1 commented Jul 25, 2022

@nikolas-burkoff after spending some time trying to reason from a user's perspective, I would suggest the following:
-move the technical side of teal.data functions that are in teal vignettes to teal.data vignettes.
-Keep the actual teal vignettes and instead of explaining the details of the functionality, we could show the necessary functions needed from teal.data (to add general data for example) with an app example and refer to the teal.data vignettes for more explanation.

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

No branches or pull requests

2 participants