xlcCall: Automatic argument vectorization, default Java exception and...

Description Usage Arguments Details Value Author(s) See Also

View source: R/xlcCall.R

Description

Performs automatic argument vectorization, provides default Java exception and warnings handling for XLConnect.

Usage

1
xlcCall(obj, fun, ..., .recycle = TRUE, .simplify = TRUE)

Arguments

obj

XLConnect S4 object (e.g workbook, cellstyle) which has a slot jobj representing a rJava jobjRef object whose method represented by the argument fun should be called.

fun

Name of Java method to be called.

...

Arguments to the Java method to be called.

.recycle

If TRUE (default), arguments passed through ... will be automatically vectorized using mapply and fun will be called the appropriate amount of times. If FALSE, no vectorization will take place in R and fun will be called once only. This may be used to implement vectorization on the Java side.

.simplify

Only relevant if .recycle = TRUE. Argument to internal mapply to set if there should be an attempt to reduce the result to a vector or matrix.

Details

This function makes use of mapply to perform automatic argument vectorization. Non-atomic arguments are wrapped in a list using wrapList first. The list of the resulting arguments is then being vectorized using mapply before the specified function is being called. The function call is wrapped with jTryCatch to catch Java exceptions. Further, any warnings are retrieved from the Java side and are logged via R's standard warning mechanism.

Value

Result of the specified function by calling it with the vectorized argument list.

Author(s)

Martin Studer
Mirai Solutions GmbH https://mirai-solutions.ch

See Also

wrapList, jTryCatch


XLConnect documentation built on April 11, 2021, 9:06 a.m.