operator-pipe {bdpar}R Documentation

bdpar customized forward-pipe operator

Description

Defines a customized forward pipe operator extending the features of classical %>%. Concretely %>|% is able to stop the pipelining process whenever an Instance has been invalidated. This issue, avoids executing the whole pipelining process for the invalidated Instance and therefore reduce the time and resources used to complete the whole process.

Usage

lhs %>|% rhs

Arguments

lhs

an Instance object.

rhs

a function call using the bdpar semantics.

Value

The Instance modified by the methods it has traversed.

Details

This is the %>% operator of the modified magrittr library to both (i) to stop the flow when the Instance is invalid and (ii) automatically call the pipe function of the R6 objects passing through it (iii) to check the dependencies of the Instance and (iv) to manage the pipeline cache.

The usage structure would be as shown below:

instance %>|%

pipeObject$new() %>|%

pipeObject$new(<<argument1>>, <<argument2>, ...) %>|%

pipeObject$new()

Note

Pipelining process is automatically stopped if the Instance is invalid.

See Also

bdpar.Options, Instance, GenericPipe


[Package bdpar version 3.0.0 Index]