register_S3_method {box}R Documentation

Register S3 methods

Description

register_S3_method makes an S3 method for a given generic and class known inside a module.

Usage

register_S3_method(name, class, method)

Arguments

name

the name of the generic as a character string.

class

the class name.

method

the method to register.

Details

Methods for generics defined in the same module do not need to be registered explicitly, and indeed should not be registered. However, if the user wants to add a method for a known generic (defined outside the module, e.g. print), then this needs to be made known explicitly.

See the vignette in vignette('box', 'box') for more information on defining S3 methods inside modules.

Value

register_S3_method is called for its side-effect.

Note

Do not call registerS3method inside a module. Only use register_S3_method. This is important for the module’s own book-keeping.


[Package box version 1.0.2 Index]