You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 datasetshere 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:
Nor outputs like this:
The text was updated successfully, but these errors were encountered:
@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.
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 ofteal::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 ofdatasets
here but that should not interfere with this issueWe should also fix the formatting and outputs - see the pkgdown website for example:
teal
vignettes and move the technical details toteal.data
and keep only examples inteal
:teal
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:

Nor outputs like this:


The text was updated successfully, but these errors were encountered: