From 47f096e5fa7e604792a5df01de76ddc91949cf0d Mon Sep 17 00:00:00 2001 From: Dony Unardi Date: Mon, 3 Feb 2025 14:52:29 -0800 Subject: [PATCH] Update vignettes/customizing-module-output.Rmd MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Dawid Kałędkowski Signed-off-by: Dony Unardi --- vignettes/customizing-module-output.Rmd | 1 + 1 file changed, 1 insertion(+) diff --git a/vignettes/customizing-module-output.Rmd b/vignettes/customizing-module-output.Rmd index 4166661d7..cba518c89 100644 --- a/vignettes/customizing-module-output.Rmd +++ b/vignettes/customizing-module-output.Rmd @@ -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.