P281424/AMR
1
0
Fork 0
mirror of https://github.com/msberends/AMR.git synced 2025-07-12 02:22:08 +02:00
Code Releases Activity

(v2.1.1.9233) chore: make all argument texts full sentences

Browse Source
This commit is contained in:
dr. M.S. (Matthijs) Berends
2025-03-31 14:53:24 +02:00
parent 63099cd81e
commit 1fdab84103
91 changed files with 720 additions and 701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
R/ggplot_pca.R
View File

@ -30,27 +30,27 @@
#' PCA Biplot with `ggplot2`
#'
#' Produces a `ggplot2` variant of a so-called [biplot](https://en.wikipedia.org/wiki/Biplot) for PCA (principal component analysis), but is more flexible and more appealing than the base \R [biplot()] function.
#' @param x An object returned by [pca()], [prcomp()] or [princomp()]
#' @param x An object returned by [pca()], [prcomp()] or [princomp()].
#' @inheritParams stats::biplot.prcomp
#' @param labels An optional vector of labels for the observations. If set, the labels will be placed below their respective points. When using the [pca()] function as input for `x`, this will be determined automatically based on the attribute `non_numeric_cols`, see [pca()].
#' @param labels_textsize The size of the text used for the labels
#' @param labels_text_placement Adjustment factor the placement of the variable names (`>=1` means further away from the arrow head)
#' @param labels_textsize The size of the text used for the labels.
#' @param labels_text_placement Adjustment factor the placement of the variable names (`>=1` means further away from the arrow head).
#' @param groups An optional vector of groups for the labels, with the same length as `labels`. If set, the points and labels will be coloured according to these groups. When using the [pca()] function as input for `x`, this will be determined automatically based on the attribute `non_numeric_cols`, see [pca()].
#' @param ellipse A [logical] to indicate whether a normal data ellipse should be drawn for each group (set with `groups`)
#' @param ellipse_prob Statistical size of the ellipse in normal probability
#' @param ellipse_size The size of the ellipse line
#' @param ellipse_alpha The alpha (transparency) of the ellipse line
#' @param points_size The size of the points
#' @param points_alpha The alpha (transparency) of the points
#' @param arrows A [logical] to indicate whether arrows should be drawn
#' @param arrows_textsize The size of the text for variable names
#' @param arrows_colour The colour of the arrow and their text
#' @param arrows_size The size (thickness) of the arrow lines
#' @param arrows_textsize The size of the text at the end of the arrows
#' @param arrows_textangled A [logical] whether the text at the end of the arrows should be angled
#' @param arrows_alpha The alpha (transparency) of the arrows and their text
#' @param base_textsize The text size for all plot elements except the labels and arrows
#' @param ... Arguments passed on to functions
#' @param ellipse A [logical] to indicate whether a normal data ellipse should be drawn for each group (set with `groups`).
#' @param ellipse_prob Statistical size of the ellipse in normal probability.
#' @param ellipse_size The size of the ellipse line.
#' @param ellipse_alpha The alpha (transparency) of the ellipse line.
#' @param points_size The size of the points.
#' @param points_alpha The alpha (transparency) of the points.
#' @param arrows A [logical] to indicate whether arrows should be drawn.
#' @param arrows_textsize The size of the text for variable names.
#' @param arrows_colour The colour of the arrow and their text.
#' @param arrows_size The size (thickness) of the arrow lines.
#' @param arrows_textsize The size of the text at the end of the arrows.
#' @param arrows_textangled A [logical] whether the text at the end of the arrows should be angled.
#' @param arrows_alpha The alpha (transparency) of the arrows and their text.
#' @param base_textsize The text size for all plot elements except the labels and arrows.
#' @param ... Arguments passed on to functions.
#' @source The [ggplot_pca()] function is based on the `ggbiplot()` function from the `ggbiplot` package by Vince Vu, as found on GitHub: <https://github.com/vqv/ggbiplot> (retrieved: 2 March 2020, their latest commit: [`7325e88`](https://github.com/vqv/ggbiplot/commit/7325e880485bea4c07465a0304c470608fffb5d9); 12 February 2015).
#'
#' As per their GPL-2 licence that demands documentation of code changes, the changes made based on the source code were: