alr: Additive log-ratio functions

Description Usage Arguments

View source: R/normalization.R

Description

Additive log-ratio functions

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
alr(x.f, ...)

## Default S3 method:
alr(x.f, divcomp = 1, base = exp(1),
  removeDivComp = TRUE, tol = .Machine$double.eps, ...)

## S3 method for class 'matrix'
alr(x.f, mar = 2, divcomp = 1, base = exp(1),
  removeDivComp = TRUE, tol = .Machine$double.eps, ...)

## S3 method for class 'data.frame'
alr(x.f, mar = 2, ...)

Arguments

x.f

input data

...

pass through arguments

divcomp

the index of the component to use as the divisor

base

base for log transformation

removeDivComp

remove the divisor component from the alr result

tol

tolerance for a numerical zero

mar

margin to apply the transformation (rows: 1 or cols: 2)


zdk123/SpiecEasi documentation built on Oct. 1, 2018, 2:12 p.m.