Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rCarto committed Oct 17, 2023
1 parent c32d32a commit 7e7708f
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 34 deletions.
2 changes: 1 addition & 1 deletion R/leg.R
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
#' @param horiz if TRUE plot an horizontal legend
#' @param adj adjust the postion of the legend in x and y directions.
#' @param frame_border border color of the frame
#' @return No return value, a legend is displayed.
#' @return No value is returned, a legend is displayed.
#' @export
#' @details
#' Some arguments are available for all types of legend: `val`, `pos`, `title`,
Expand Down
17 changes: 1 addition & 16 deletions R/leg_comp.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#' The "type" argument defines the
#' legend type.
#' Please note that some arguments are available for all types of legend and
#' some others are only relevant for specific legend types (see Details).
#' some others are only relevant for specific legend types.
#'
#' @md
#' @param leg legend object
Expand Down Expand Up @@ -48,21 +48,6 @@
#' @param horiz if TRUE plot an horizontal legend
#' @return A list of legends parameters is returned.
#' @export
#' @details
#' Some arguments are available for all types of legend: `val`,
#' `adj`, `title`).
#'
#'
#' Relevant arguments for each specific legend types:
#' * `leg(type = "prop", val, inches, symbol, col, lwd, border, val_rnd, self_adjust, horiz)`
#' * `leg(type = "choro", val, pal, val_rnd, col_na, no_data, no_data_txt, box_border, horiz)`
#' * `leg(type = "cont", val, pal, val_rnd, col_na, no_data, no_data_txt, box_border, horiz)`
#' * `leg(type = "typo", val, pal, col_na, no_data, no_data_txt, box_border)`
#' * `leg(type = "symb", val, pal, pch, cex, lwd, pch_na, cex_na, col_na, no_data, no_data_txt)`
#' * `leg(type = "prop_line", val, col, lwd, val_rnd)`
#' * `leg(type = "grad_line", val, col, lwd, val_rnd)`
#'
#'
#' @examples
#' # minimal example
#' plot.new()
Expand Down
2 changes: 1 addition & 1 deletion man/leg.Rd

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

17 changes: 1 addition & 16 deletions man/leg_comp.Rd

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

0 comments on commit 7e7708f

Please sign in to comment.