R/cenLRinv.R In robCompositions: Compositional Data Analysis

Documented in cenLRinv

#' Inverse centred logratio mapping
#'
#' Applies the inverse centred logratio mapping.
#'
#'
#' @param x an object of class \dQuote{clr}, \dQuote{data.frame} or
#' \dQuote{matrix}
#' @param useClassInfo if the object is of class \dQuote{clr}, the useClassInfo
#' is used to determine if the class information should be used. If yes, also
#' absolute values may be preserved.
#' @return the resulting compositional data set.
#' @author Matthias Templ
#' @references Aitchison, J. (1986) \emph{The Statistical Analysis of
#' Compositional Data} Monographs on Statistics and Applied Probability.
#' Chapman \& Hall Ltd., London (UK). 416p.
#' @keywords manip
#' @export
#' @examples
#'
#' data(expenditures)
#' eclr <- cenLR(expenditures, 2)
#' inveclr <- cenLRinv(eclr)
#' head(cenLRinv(eclr$x.clr)) #' cenLRinv <- function(x, useClassInfo=TRUE){ clInfo <- class(x)[1] if(clInfo != "clr" & useClassInfo == TRUE) warning("useClassInfo was set to FALSE, because x is not from class clr") if(!(clInfo %in% c("clr", "data.frame", "matrix"))) stop("class from x must be either clr, data.frame or matrix") # if(!is.null(x$base)){
#   if(!identical(x$base, exp(1))) warning("\n absolute values currently not preserved \n since base was different to exp(1)") # } if(clInfo == "clr") xclr <- x$x.clr
if(clInfo == "clr" & useClassInfo==TRUE){
dat <- exp(xclr)  * x\$gm
} else if(clInfo != "clr" | useClassInfo==FALSE){
dat <- exp(x)
}
return(dat)
}


Try the robCompositions package in your browser

Any scripts or data that you put into this service are public.

robCompositions documentation built on Jan. 13, 2021, 10:07 p.m.