% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/checkData.R
\name{checkData}
\alias{checkData}
\title{check input data type and format and coerce to the desired output type}
\usage{
checkData(
  x,
  method = c("xts", "zoo", "data.frame", "matrix", "vector"),
  na.rm = TRUE,
  quiet = TRUE,
  ...
)
}
\arguments{
\item{x}{a vector, matrix, data.frame, xts, timeSeries or zoo object to be
checked and coerced}

\item{method}{type of coerced data object to return, one of
c("xts", "zoo", "data.frame", "matrix", "vector"), default "xts"}

\item{na.rm}{TRUE/FALSE Remove NA's from the data? used only with 'vector'}

\item{quiet}{TRUE/FALSE if false, it will throw warnings when errors are
noticed, default TRUE}

\item{\dots}{any other passthru parameters}
}
\description{
This function was created to make the different kinds of data classes at
least \emph{seem} more fungible.  It allows the user to pass in a data
object without being concerned that the function requires a matrix,
data.frame, vector, xts, or timeSeries object.  By using \code{checkData}, 
the function "knows" what data format it has to work with.
}
\examples{

data(edhec)
x = checkData(edhec)
class(x)
head(x)
tail(x)
# Note that passing in a single column loses the row and column names
x = checkData(edhec[,1])
class(x)
head(x)
# Include the "drop" attribute to keep row and column names
x = checkData(edhec[,1,drop=FALSE])
class(x)
head(x)
x = checkData(edhec, method = "matrix")
class(x)
head(x)
x = checkData(edhec[,1], method = "vector")
class(x)
head(x)

}
\author{
Peter Carl
}
