checkData: check input data type and format and coerce to the desired...

Description Usage Arguments Author(s) Examples

Description

This function was created to make the different kinds of data classes at least 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 checkData, the function "knows" what data format it has to work with.

Usage

1
2
checkData(x, method = c("xts", "zoo", "data.frame", "matrix", "vector"),
  na.rm = TRUE, quiet = TRUE, ...)

Arguments

x

a vector, matrix, data.frame, xts, timeSeries or zoo object to be checked and coerced

method

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

na.rm

TRUE/FALSE Remove NA's from the data? used only with 'vector'

quiet

TRUE/FALSE if false, it will throw warnings when errors are noticed, default TRUE

...

any other passthru parameters

Author(s)

Peter Carl

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
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)


Search within the PerformanceAnalytics package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.