-
-
Notifications
You must be signed in to change notification settings - Fork 41
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
Have different constructor for "Data" module and "Transform" module #1283
Have different constructor for "Data" module and "Transform" module #1283
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please link [teal_transform_module()]
in description transformers
argument in docs of teal_module
function. Please review current teal_module
and teal_transform_module
documentation and write comprehensive description aimed for app developer - app developer needs to know everything about how teal_transform_module
and teal_module
works, but don't need to know FilteredData
. What I mean by this is that you did right writing "passed through filter panel" but writing "modules" should not occur in this case. App developer needs to understand that teal_data
object is sequenced through all teal_transform_modules
' servers (it is a list) and eventually it is handed over to the server of teal_module
Roxygen docs should be more technical, while vignette should be focused on usage
Would be nice if @donyunardi looked at this content
…e@669_insertUI@main
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Provided some alternative to the content.
mtcars <- mtcars | ||
}) | ||
|
||
my_transformers <- list( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since we're only using one teal_transform_module
, perhaps we don't need to wrap it in a list
? This will set the stage for the next example when we do have multiple teal_transform_modules
wrapped in a list
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess it makes sense, but let me think about this. Currently we have:
module
is wrapped bymodules
teal_slice
is wrappedteal_slices
teal_data_module
is not wrapped by anythingteal_transform_module
is wrapped bylist()
|
||
app <- init( | ||
data = data, | ||
modules = example_module() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we use a very simple module()
so that it's clear that transformer
is passed as an argument to this function?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think vignette should elaborate more about creating module
which consumes transformers.
I've updated description here: #1231
Adds
teal_transform_module()
to be used to create data modules for transformation.Example usage