diff --git a/NEWS.md b/NEWS.md index b89369c..87e0971 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,5 +1,5 @@ # dimensio 0.4.0 -** Use graphics instead of ggplot2.** +**Use graphics instead of ggplot2.** ## New classes and methods * Add `screeplot()` to produce a scree plot. diff --git a/R/AllGenerics.R b/R/AllGenerics.R index 41dd48b..9689bec 100644 --- a/R/AllGenerics.R +++ b/R/AllGenerics.R @@ -567,8 +567,9 @@ 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.} @@ -576,6 +577,18 @@ NULL #' \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`. diff --git a/man/viz_coordinates.Rd b/man/viz_coordinates.Rd index d6c79f2..6f65352 100644 --- a/man/viz_coordinates.Rd +++ b/man/viz_coordinates.Rd @@ -97,7 +97,7 @@ viz_variables(x, ...) \arguments{ \item{x}{A \code{\linkS4class{CA}} or \code{\linkS4class{PCA}} object.} -\item{...}{Currently not used.} +\item{...}{Further \link[graphics:par]{graphical parameters} (see below).} \item{axes}{A length-two \code{\link{numeric}} vector giving the dimensions to be plotted.} @@ -130,6 +130,7 @@ being displayed. Invisibly returns \code{x}. Plots principal coordinates. } \details{ +Available statistics: \describe{ \item{\code{observation}}{Whether an observation is active or supplementary.} \item{\code{mass}}{Weight/mass of each observation.} @@ -137,6 +138,18 @@ Plots principal coordinates. \item{\code{contribution}}{Joint contributions to the definition of \code{axes}.} \item{\code{cos2}}{Joint \eqn{cos^2}{cos2} along \code{axes}.} } + +Commonly used \link[graphics:par]{graphical parameters} are: +\describe{ +\item{\code{col}}{The colors for lines and points. Multiple colors can be +specified so that each point can be given its own color.} +\item{\code{pch}}{A vector of plotting characters or symbols.} +\item{\code{cex}}{A \code{numeric} vector giving the amount by which plotting +characters and symbols should be scaled relative to the +default.} +\item{\code{lty}}{A vector of line types.} +\item{\code{lwd}}{A vector of line widths.} +} } \examples{ ## Load data