Skip to content

Commit 7e7708f

Browse files
committed
docs: update documentation
1 parent c32d32a commit 7e7708f

File tree

4 files changed

+4
-34
lines changed

4 files changed

+4
-34
lines changed

R/leg.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
#' @param horiz if TRUE plot an horizontal legend
6060
#' @param adj adjust the postion of the legend in x and y directions.
6161
#' @param frame_border border color of the frame
62-
#' @return No return value, a legend is displayed.
62+
#' @return No value is returned, a legend is displayed.
6363
#' @export
6464
#' @details
6565
#' Some arguments are available for all types of legend: `val`, `pos`, `title`,

R/leg_comp.R

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#' The "type" argument defines the
44
#' legend type.
55
#' Please note that some arguments are available for all types of legend and
6-
#' some others are only relevant for specific legend types (see Details).
6+
#' some others are only relevant for specific legend types.
77
#'
88
#' @md
99
#' @param leg legend object
@@ -48,21 +48,6 @@
4848
#' @param horiz if TRUE plot an horizontal legend
4949
#' @return A list of legends parameters is returned.
5050
#' @export
51-
#' @details
52-
#' Some arguments are available for all types of legend: `val`,
53-
#' `adj`, `title`).
54-
#'
55-
#'
56-
#' Relevant arguments for each specific legend types:
57-
#' * `leg(type = "prop", val, inches, symbol, col, lwd, border, val_rnd, self_adjust, horiz)`
58-
#' * `leg(type = "choro", val, pal, val_rnd, col_na, no_data, no_data_txt, box_border, horiz)`
59-
#' * `leg(type = "cont", val, pal, val_rnd, col_na, no_data, no_data_txt, box_border, horiz)`
60-
#' * `leg(type = "typo", val, pal, col_na, no_data, no_data_txt, box_border)`
61-
#' * `leg(type = "symb", val, pal, pch, cex, lwd, pch_na, cex_na, col_na, no_data, no_data_txt)`
62-
#' * `leg(type = "prop_line", val, col, lwd, val_rnd)`
63-
#' * `leg(type = "grad_line", val, col, lwd, val_rnd)`
64-
#'
65-
#'
6651
#' @examples
6752
#' # minimal example
6853
#' plot.new()

man/leg.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/leg_comp.Rd

Lines changed: 1 addition & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)