Skip to content

Commit

Permalink
Document missing arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
olivroy committed May 2, 2024
1 parent a860238 commit 2a2f470
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 18 deletions.
10 changes: 2 additions & 8 deletions R/tm_facets.R
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,12 @@
#' and columns are dropped.
#' @param drop.NA.facets Logical. If the `by` argument is specified, and all
#' data values for specific facets are missing, should these facets be dropped?
#' `FALSE` by default.
#' `FALSE` by default. In v3, it was called `showNA`.
#' @param sync Logical. Should the navigation in view mode (zooming and panning)
#' be synchronized? By default `TRUE` if the facets have the same bounding box.
#' This is generally the case when rasters are plotted, or when `free.coords` is
#' `FALSE`.
#' @param showNA If the `by` argument is specified, should missing values of the
#' `by`-variable be shown in a facet? If two `by`-variables are specified,
#' should missing values be shown in an additional row and column?
#' If `NA`, missing values only are shown if they exist. Similar to the
#' `useNA` argument of [table()][base::table()], where `TRUE`, `FALSE`,
#' and `NA` correspond to `"always"`, `"no"`, and `"ifany"` respectively.
#' @param textNA Text used for facets of missing values.
#' @param na.text Text used for facets of missing values. In v3, it was `textNA`.
#' @param scale.factor Number that determines how the elements (e.g. font sizes,
#' symbol sizes, line widths) of the small multiples are scaled in relation to
#' the scaling factor of the shapes. The elements are scaled to the `scale.factor`th
Expand Down
2 changes: 2 additions & 0 deletions R/tm_scale_.R
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,8 @@ tm_scale_discrete = function(ticks = NA,
#' @param label.na (generic scale argument) Label for missing values
#' @param label.null (generic scale argument) Label for null (out-of-scope) values
#' @param label.format (generic scale argument) Label formatting (similar to `legend.format` in tmap3)
#' @param trans.args list of additional argument for the transformation (generic transformation arguments)
#' @inheritParams scales::transform_pseudo_log
#' @export
#' @rdname tm_scale_continuous
#' @name tm_scale_continuous
Expand Down
13 changes: 3 additions & 10 deletions man/tm_facets.Rd

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

6 changes: 6 additions & 0 deletions man/tm_scale_continuous.Rd

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

0 comments on commit 2a2f470

Please sign in to comment.