UnivariateProjection: ** RESERVED FOR INTERNAL USE **

View source: R/z_projections.R

UnivariateProjectionR Documentation

** RESERVED FOR INTERNAL USE **

Description

Univariate projection

Usage

UnivariateProjection(
  X,
  Y = NULL,
  grp = NULL,
  proportions = NULL,
  ordering = NULL,
  rounding = 2,
  spray = "uniform",
  fwhm = 1/2,
  violin = FALSE,
  vmode = "linear"
)

Arguments

X

numeric vector or matrix with positive values, for instance representing empirical densities or weights. When providing a matrix, each column of X corresponds to a group, and the membership of each observation (rows) is being defined by the grp argument.

grp

vector representing group memberships, required only when the X argument is a matrix with more than 1 column. In this case, the length of grp must be equal to nrow(X) and its values must be integers between 1 and ncol(X).

proportions

either "static", "global", "local" or NULL (default, no proportions). In static mode, the areas representing each group are equal. In global mode, these areas are proportional to the global population of each group and in local mode, these areas are proportional to the local population of each group.

ordering

either "static", "global" or "local" or NULL (default, no ordering). In static mode, groups are ordered by their numeric identifier. In global mode, groups are ordered by their global population and in local mode, groups are ordered by their local population.

rounding

integer (default = 2).

spray

defines the distribution used to generate noise values. This can be either "uniform" (default), "triangle", "cosine", or "normal". It is possible to use non-ambiguous abbreviated forms of these keywords.

fwhm

positive numeric value defining the Full Width at Half Maximum of the normal distribution used when spray = "normal". The default value is 0.5 and produces normally distributed noise values with a similar span as when using the triangle and cosine distributions which both have the same FWHM of 0.5 by design.

violin

logical (default = FALSE, no).

vmode

either "linear" (default) or "rank".

Value

UnivariateProjection returns a numeric vector representing 1D coordinates.

See Also

BivariateProjection, Atomize


benja0x40/Barbouille documentation built on March 26, 2023, 11:38 p.m.