validate_pipe_component: Validate pipe component class

In kota7/MLPipe: Machine Learning Pipeline

Description

Check if an R6 class satisfies the minimum conditions for pipe components

Usage

validate_pipe_component(x, verbose = 3)

Arguments

x	R object, typically an R6ClassGenerator
verbose	integer. if 0, no message is given. if 1, reports only invalidity. if 2, reports simple progress. if 3+, reports details.

Details

This function is used by developers of pipe component to check if a class satisfies the minimum properties for a pipe component class. It is also used by the package developer for package test process to check the validity of the exported pipe component classes.

Value

logical that indicates that x satisfies the minimum conditions for a valid pipe component class

See Also

custom_pipe_component

Examples

validate_pipe_component(MLP)
validate_pipe_component(PipeComponent)

# bad examples
validate_pipe_component(custom_pipe_component(predict=function(x, y, ...) { }))
validate_pipe_component(custom_pipe_component(get_parameters=function(z) { }))

kota7/MLPipe documentation built on May 5, 2019, 5:53 p.m.