|
a |
|
b/OmicsFold/man/normalise.clr.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/MixMC.R |
|
|
3 |
\name{normalise.clr} |
|
|
4 |
\alias{normalise.clr} |
|
|
5 |
\title{Apply centered log-ratio normalisation} |
|
|
6 |
\usage{ |
|
|
7 |
normalise.clr(input, offset = 0) |
|
|
8 |
} |
|
|
9 |
\arguments{ |
|
|
10 |
\item{input}{Scaled OTU data as proportions 0-1, e.g. output by |
|
|
11 |
normalise.TSS().} |
|
|
12 |
|
|
|
13 |
\item{offset}{Optional offset to apply to raw data to avoid logging of zero |
|
|
14 |
values. Only needed if any zeroes are present - should generally be set very |
|
|
15 |
small, e.g. 0.000001.} |
|
|
16 |
} |
|
|
17 |
\value{ |
|
|
18 |
Data normalised by the CLR method. |
|
|
19 |
} |
|
|
20 |
\description{ |
|
|
21 |
Apply centered log-ratio (CLR) normalisation to sum scaled OTU count data. |
|
|
22 |
This is another method for converting the compositional data, i.e. |
|
|
23 |
proportional data in the range 0..1 to Euclidean space which is most |
|
|
24 |
appropriate for the linear models. Note that this should only be applied to |
|
|
25 |
OTU data, as it applies another inter-sample normalisation. |
|
|
26 |
} |
|
|
27 |
\examples{ |
|
|
28 |
\dontrun{ |
|
|
29 |
normalise.clr(otu.data.tss) |
|
|
30 |
} |
|
|
31 |
} |