Skip to content
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

Update to roxygen2 @template for ggplot2_args arguments #694

Merged
merged 2 commits into from
Feb 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ SECURITY.md
^Jenkinsfile$
^logs$
^Makefile$
^man-roxygen$
^man/roxygen$
^Meta$
^outputdir$
^scratch$
Expand Down
7 changes: 0 additions & 7 deletions man-roxygen/ggplot2_args_multi.R

This file was deleted.

8 changes: 8 additions & 0 deletions man/roxygen/templates/ggplot2_args_multi.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#' @param ggplot2_args (`ggplot2_args` or `named list` of `ggplot2_args`s) optional.
#' Object created by [`teal.widgets::ggplot2_args()`] and contains settings for all the plots,
#' or is a named `list` of `ggplot2_args` objects for plot-specific settings.
#' The argument is merged with options variable `teal.ggplot2_args` and default module setup.
#'
#' List names should match the following: `c("default", <%=ggnames%>)`.
#'
#' For more details see the vignette: `vignette("custom-ggplot2-arguments", package = "teal.widgets")`.
5 changes: 3 additions & 2 deletions man/tm_a_pca.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions man/tm_a_regression.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions man/tm_g_association.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions man/tm_g_distribution.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions man/tm_missing_data.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions man/tm_outliers.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.