prepareArgs: Argument Handler Function

In tpq/amalgam: Amalgamation-Based Dimension Reduction of Compositional Data

Description

This function handles arguments for amalgam.

Usage

prepareArgs(
  x,
  n.amalgams = 3,
  maxiter = ncol(x) * 10,
  z = NULL,
  objective = objective.keepDist,
  weights = weight.Nto1,
  asSLR = FALSE,
  shrink = FALSE,
  ...
)

Arguments

x	A matrix. The input data. Rows are samples and columns are components.
n.amalgams	An intger. How many components the amalgamation should have.
maxiter	An integer. How long the genetic algorithm should run.
z	A matrix. The constraining matrix. Optional.
objective	A function. The objective function. See above.
weights	A function. The weights function. See above.
asSLR	A boolean. Toggles whether to turn the amalgams into a set of summed log-ratios (SLRs). See as.slr.
shrink	A boolean. Toggles whether to estimate bin frequencies from the count vectors by James-Stein-type shrinkage.
...	Arguments passed to GA::ga function.

Value

A list of arguments.

tpq/amalgam documentation built on March 14, 2020, 10:27 a.m.