wyz.code.rdoc (version 1.1.7)

generateWrapperObject: Generate wrapper object.

Description

Use method generateWrapperObject to generate a wrapper object.

Usage

generateWrapperObject(fun_f_1, functionName_ch_1 = NA)

Arguments

fun_f_1

A 1-length vector holding a function, to be encapsulated into the object.

functionName_ch_1

A 1-length vector of character values, expressing the function name.

Value

An object of class WrapperObject that could be used to easily generate manual pages using wyz.code.rdoc.

Examples

# NOT RUN {
# typical case
myfun <- function(x_i, y_i) { x_i + y_i}
o <- generateWrapperObject(myfun)
print(o)
# <environment: 0x0000021d7abd9710>
# attr(,"class")
# [1] "WrapperObject" "environment"
ls(o)
# [1] "removeEllipsisName" "self"
# }