Revision 9ae1e67cb5e13c5bbc731a5fc56a0053182f16b0 authored by Matthias Templ on 11 February 2020, 16:20:02 UTC, committed by cran-robot on 11 February 2020, 16:20:02 UTC
1 parent 775c7e1
Raw File
impCoda.Rd
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/impCoda.R
\name{impCoda}
\alias{impCoda}
\title{Imputation of missing values in compositional data}
\usage{
impCoda(
  x,
  maxit = 10,
  eps = 0.5,
  method = "ltsReg",
  closed = FALSE,
  init = "KNN",
  k = 5,
  dl = rep(0.05, ncol(x)),
  noise = 0.1,
  bruteforce = FALSE
)
}
\arguments{
\item{x}{data frame or matrix}

\item{maxit}{maximum number of iterations}

\item{eps}{convergence criteria}

\item{method}{imputation method}

\item{closed}{imputation of transformed data (using ilr transformation) or
in the original space (\code{closed} equals TRUE)}

\item{init}{method for initializing missing values}

\item{k}{number of nearest neighbors (if init $==$ \dQuote{KNN})}

\item{dl}{detection limit(s), only important for the imputation of rounded
zeros}

\item{noise}{amount of adding random noise to predictors after convergency}

\item{bruteforce}{if TRUE, imputations over dl are set to dl. If FALSE,
truncated (Tobit) regression is applied.}
}
\value{
\item{xOrig }{Original data frame or matrix} \item{xImp }{Imputed
data} \item{criteria }{Sum of the Aitchison distances from the present and
previous iteration} \item{iter }{Number of iterations} \item{maxit }{Maximum
number of iterations } \item{w }{Amount of imputed values} \item{wind
}{Index of the missing values in the data}
}
\description{
This function offers different methods for the imputation of missing values
in compositional data. Missing values are initialized with proper values.
Then iterative algorithms try to find better estimations for the former
missing values.
}
\details{
eps: The algorithm is finished as soon as the imputed values stabilize, i.e.
until the sum of Aitchison distances from the present and previous iteration
changes only marginally (eps).\

method: Several different methods can be chosen, such as \sQuote{ltsReg}:
least trimmed squares regression is used within the iterative procedure.
\sQuote{lm}: least squares regression is used within the iterative
procedure.  \sQuote{classical}: principal component analysis is used within
the iterative procedure.  \sQuote{ltsReg2}: least trimmed squares regression
is used within the iterative procedure.  The imputated values are perturbed
in the direction of the predictor by values drawn form a normal distribution
with mean and standard deviation related to the corresponding residuals and
multiplied by \code{noise}.
}
\examples{

data(expenditures)
x <- expenditures
x[1,3]
x[1,3] <- NA
xi <- impCoda(x)$xImp
xi[1,3]
s1 <- sum(x[1,-3])
impS <- sum(xi[1,-3])
xi[,3] * s1/impS

}
\references{
Hron, K., Templ, M., Filzmoser, P. (2010) Imputation of
missing values for compositional data using classical and robust methods
\emph{Computational Statistics and Data Analysis}, 54 (12),
3095-3107.
}
\seealso{
\code{\link{impKNNa}}, \code{\link{pivotCoord}}
}
\author{
Matthias Templ, Karel Hron
}
\keyword{iteration}
\keyword{multivariate}
\keyword{robust}
back to top