check_distribution: Check that distribution is sums up to one.

In charlotterich/immunarch_code: Painless Bioinformatics Analysis of T-Cell and B-Cell Immune Repertoires in R

Description

Check if the given .data is a distribution and normalise it if necessary with an optional laplace correction.

Usage

check_distribution(
  .data,
  .do.norm = NA,
  .laplace = 1,
  .na.val = 0,
  .warn.zero = F,
  .warn.sum = T
)

Arguments

.data	Numeric vector of values.
.do.norm	One of the three values - NA, T or F. If NA then check for distrubution (sum(.data) == 1) and normalise if needed with the given laplace correction value. if T then do normalisation and laplace correction. If F then don't do normalisaton and laplace correction.
.laplace	Value for the laplace correction.
.na.val	Replace all NAs with this value.
.warn.zero	if T then the function checks if in the resulted vector (after normalisation) are any zeros, and prints a warning message if there are some.
.warn.sum	if T then the function checks if the sum of resulted vector (after normalisation) is equal to one, and prints a warning message if not.

Value

Numeric vector.

charlotterich/immunarch_code documentation built on Jan. 24, 2020, 12:08 a.m.