Skip to content

Commit

Permalink
Update to roxygen2 @template for ggplot2_args arguments (#694)
Browse files Browse the repository at this point in the history
# Pull Request

<!--- Replace `#nnn` with your issue link for reference. -->

- Closes #695
- Part of #624

#### Changes description

- Update type in `ggplot2_args`
- Minor change to phrasing
- Move template file under `man` page to avoid extra folder at root
level ([available
since](https://roxygen2.r-lib.org/news/index.html?q=template#options-7-0-0)
`[email protected]`)
- Update `.Rbuildignore` accordingly

#### Reviewer should consider

- `@template` has been superseded
(https://roxygen2.r-lib.org/articles/reuse.html?q=template#superseded)
  - There's no equivalent though _(with parameterized strings)_
- Alternative: we could add `ggplot2_args` to `shared_params` and
specific list of names it can take in `@details` on each function that
uses this
  • Loading branch information
averissimo authored Feb 28, 2024
1 parent 87f6eee commit bddee61
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 20 deletions.
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.

0 comments on commit bddee61

Please sign in to comment.