Skip to content

Commit

Permalink
Small edit
Browse files Browse the repository at this point in the history
  • Loading branch information
nfrerebeau committed Aug 17, 2023
1 parent 6cce714 commit a450842
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
15 changes: 14 additions & 1 deletion R/AllGenerics.R
Original file line number Diff line number Diff line change
Expand Up @@ -567,15 +567,28 @@ NULL
#' If `NULL` (the default), no highlighting is applied.
#' @param main A [`character`] string giving a main title for the plot.
#' @param sub A [`character`] string giving a subtitle for the plot.
#' @param ... Currently not used.
#' @param ... Further [graphical parameters][graphics::par] (see below).
#' @details
#' Available statistics:
#' \describe{
#' \item{`observation`}{Whether an observation is active or supplementary.}
#' \item{`mass`}{Weight/mass of each observation.}
#' \item{`sum`}{Sum of squared coordinates along `axes`.}
#' \item{`contribution`}{Joint contributions to the definition of `axes`.}
#' \item{`cos2`}{Joint \eqn{cos^2}{cos2} along `axes`.}
#' }
#'
#' Commonly used [graphical parameters][graphics::par] are:
#' \describe{
#' \item{`col`}{The colors for lines and points. Multiple colors can be
#' specified so that each point can be given its own color.}
#' \item{`pch`}{A vector of plotting characters or symbols.}
#' \item{`cex`}{A `numeric` vector giving the amount by which plotting
#' characters and symbols should be scaled relative to the
#' default.}
#' \item{`lty`}{A vector of line types.}
#' \item{`lwd`}{A vector of line widths.}
#' }
#' @return
#' `viz_*()` is called for its side-effects: it results in a graphic
#' being displayed. Invisibly returns `x`.
Expand Down
15 changes: 14 additions & 1 deletion man/viz_coordinates.Rd

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

0 comments on commit a450842

Please sign in to comment.