-
-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add template for decorators parameter
- Loading branch information
1 parent
e7132b5
commit 444cd0b
Showing
1 changed file
with
15 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# nocov start | ||
roxygen_decorators_param <- function(module_name) { | ||
paste( | ||
sep = " ", | ||
lifecycle::badge("experimental"), | ||
" (`list` of `teal_transform_module`, named `list` of `teal_transform_module` or", | ||
"`NULL`) optional, if not `NULL`, decorator for tables or plots included in the module.", | ||
"When a named list of `teal_transform_module`, the decorators are applied to the", | ||
"respective output objects.\n\n", | ||
"Otherwise, the decorators are applied to all objects, which is equivalent as using the name `default`.\n\n", | ||
sprintf("See section \"Decorating `%s`\"", module_name), | ||
"below for more details." | ||
) | ||
} | ||
# nocov start |