R: Logging object to use with the lumberjack package

lbj_cells-class {validate} | R Documentation

## Logging object to use with the lumberjack package

### Description

Logging object to use with the lumberjack package

### Format

A reference class object

### Methods

`add(meta, input, output)`

  Add logging info based on in- and output

`dump(file = NULL, verbose = TRUE, ...)`

  Dump logging info to csv file. All arguments in '...' except row.names are passed to 'write.csv'

`initialize(..., verbose = TRUE, label = "")`

  Create object. Optionally toggle verbosity.

`log_data()`

  Return logged data as a data.frame

### Details

This obeject can used with the function composition ('pipe') operator of the `lumberjack` package. The logging is based on validate's `cells` function. The output is written to a `csv` file wich contains the following columns.

`step` | `integer` | Step number
`time` | `POSIXct` | Timestamp
`expr` | `character` | Expression used on data
`cells` | `integer` | Total nr of cells in dataset
`available` | `integer` | Nr of non-NA cells
`missing` | `integer` | Nr of empty (NA) cells
`still_available` | `integer` | Nr of cells still available after expr
`unadapted` | `integer` | Nr of cells still available and unaltered
`unadapted` | `integer` | Nr of cells still available and altered
`imputed` | `integer` | Nr of cells not missing anymore

### Note

This logger is suited only for operations that do not change the dimensions of the dataset.

### See Also

Other loggers: `lbj_rules-class`

[Package validate version 1.1.1 Index]