Skip to content

Commit

Permalink
Update vignettes/customizing-module-output.Rmd
Browse files Browse the repository at this point in the history
Co-authored-by: Dawid Kałędkowski <[email protected]>
Signed-off-by: Dony Unardi <[email protected]>
  • Loading branch information
donyunardi and gogonzo authored Feb 3, 2025
1 parent e68234f commit 47f096e
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions vignettes/customizing-module-output.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ To use decorators effectively, certain requirements must be met:

1. **Module Support**: While `teal` provides the core functionality for decorators, the module must explicitly support this functionality. Developers should ensure that the module has been designed to work with decorators (see [Include Decorators in a `teal` Module](#include-decorators-in-a-teal-module)).
2. **Matching Object Names**: Decorators must reference object names that align with the internal naming conventions of the module. Each module may use different names for its output objects, such as `plot` or `table`. This alignment is critical for successful decorator.
3. **Matching Object Class**: Decorated objects are used in certain context and they are use to be consumed by relevant `render*` functions. For example `ggplot` objects are used in `renderPlot` while `plotly` objects are consumed by `renderPlotly`. It is important that the object doesn't change its basic class so the module can deal with the modified object.

It is recommended to review the module documentation or source code to understand its internal object naming and object class before applying decorators.

Expand Down

0 comments on commit 47f096e

Please sign in to comment.