addHook: add a hook function to customize motusClient behaviour

Description Usage Arguments Value Note

Description

add a hook function to customize motusClient behaviour

Usage

1
addHook(hookName, f)

Arguments

hookName

character scalar hook hame; must be one of the names in names(Motus$hooks). The name indicates the motusClient function which is being customized.

f

function; the function must have the signature (rv, ...):

  1. rv the return value from the motusClient function if this hook were not added. The recommended behaviour is for f to return rv unmodified.

  2. ... the parameters accepted by the motusClient function given in hookname.

Value

TRUE; if hookName is not valid, or f is not a function, or f accepts the wrong number of parameters, then stops with an error

Note

:


jbrzusto/motusClient documentation built on May 30, 2019, 4:33 p.m.