LoggingStep-class: Constructor for LoggingStep Class.

In russHyde/flogr: An R Package for Functional Logging in Data Analysis Pipelines

Description

Encapsulates a single data-manipulation function ('modifier') and a single logging function ('logger') to compare the input/output of 'modifier'. The user should not use the (non-exported) 'run_step' method of LoggingStep directly. They should always use 'flog(in_list = some.list, logsteps = LS)' or 'flog(in_data = some.input, logsteps = LS)'.

Initialize method for LoggingStep

Arguments

modifier

A function that modifies a given dataset. This must be able to take the dataset as it's first parameter and have no other missing-but necessary parameters

logger

A function that can compare the outpur from 'modifier' against the input to that function and return a (preferably small) summary of the difference between output and input. It has obligatory first parameter-name 'post' (holds the dataset after the corresponding 'modifier' has ran) and may have an optional second parameter called 'pre' (which holds the dataset that was passed into the current 'modifier')

russHyde/flogr documentation built on May 29, 2019, 9:10 a.m.