S3WrapperGenerator: S3 wrapper method generator

View source: R/Swrappers.R

S3WrapperGeneratorR Documentation

S3 wrapper method generator

Description

Generates S3 wrapper methods for public methods of R6ClassGenerators, but can also be used to generate “plain” function wrappers.

Usage

S3WrapperGenerator(R6Method, self = "x", dots = TRUE)

Arguments

R6Method

An expression with or a public method (function) of an R6ClassGenerator.

self

A character string specifying the name of the parameter, which will take the R6 object.

dots

A logical specifying if a ... parameter shall be added as last parameter in case none already exists. This might be required for S3 generic/method consistency.

Value

Returns an S3 method (function).

See Also

S3Methods, R6::R6Class

Examples

# generate an S3 wrapper method for 'alter()' of 'DTSg'
alter.DTSg <- S3WrapperGenerator(
  R6Method = DTSg$public_methods$alter
)


DTSg documentation built on June 9, 2022, 1:06 a.m.