aboutsummaryrefslogtreecommitdiff
path: root/man/ilr.Rd
diff options
context:
space:
mode:
Diffstat (limited to 'man/ilr.Rd')
-rw-r--r--man/ilr.Rd52
1 files changed, 28 insertions, 24 deletions
diff --git a/man/ilr.Rd b/man/ilr.Rd
index 29bf7d87..0cbd7e2c 100644
--- a/man/ilr.Rd
+++ b/man/ilr.Rd
@@ -1,36 +1,29 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ilr.R
\name{ilr}
\alias{ilr}
\alias{invilr}
-\title{
- Function to perform isometric log-ratio transformation
-}
-\description{
- This implementation is a special case of the class of isometric log-ratio transformations.
-}
+\title{Function to perform isometric log-ratio transformation}
\usage{
- ilr(x)
- invilr(x)
+ilr(x)
+
+invilr(x)
}
\arguments{
- \item{x}{
- A numeric vector. Naturally, the forward transformation is only sensible for
- vectors with all elements being greater than zero.
- }
+\item{x}{A numeric vector. Naturally, the forward transformation is only
+sensible for vectors with all elements being greater than zero.}
}
\value{
- The result of the forward or backward transformation. The returned components always
- sum to 1 for the case of the inverse log-ratio transformation.
-}
-\references{
- Peter Filzmoser, Karel Hron (2008) Outlier Detection for Compositional Data Using Robust Methods. Math Geosci 40 233-248
-}
-\author{
- René Lehmann and Johannes Ranke
+The result of the forward or backward transformation. The returned
+ components always sum to 1 for the case of the inverse log-ratio
+ transformation.
}
-\seealso{
- Another implementation can be found in R package \code{robCompositions}.
+\description{
+This implementation is a special case of the class of isometric log-ratio
+transformations.
}
\examples{
+
# Order matters
ilr(c(0.1, 1, 10))
ilr(c(10, 1, 0.1))
@@ -51,6 +44,17 @@ a <- c(0.1, 0.3, 0.5)
b <- invilr(a)
length(b) # Four elements
ilr(c(b[1:3], 1 - sum(b[1:3]))) # Gives c(0.1, 0.3, 0.5)
-}
-\keyword{ manip }
+}
+\references{
+Peter Filzmoser, Karel Hron (2008) Outlier Detection for
+ Compositional Data Using Robust Methods. Math Geosci 40 233-248
+}
+\seealso{
+Another implementation can be found in R package
+ \code{robCompositions}.
+}
+\author{
+René Lehmann and Johannes Ranke
+}
+\keyword{manip}

Contact - Imprint