Uses provenance post-execution to help the user understand and debug their script by providing functions to look at intermediate steps and data values, their forwards and backwards lineage, and to understand the steps leading up to warning and error messages. 'provDebugR' uses provenance produced by 'rdtLite' (available on CRAN), stored in PROV-JSON format.
A debugging tool that leverages provenance to provide handy information about R scripts to assist in writing them.
For a more in-depth description of the functions available in this package please refer to the Wiki.
Version 3.5.0 or later of R is required.
Devtools is needed for installation:
install.packages("devtools")
Installation of all required packages (can be copied and pasted):
install.packages("provParseR")
install.packages("provGraphR")
install.packages("rdtLite")
devtools::install_github("End-to-end-provenance/provDebugR")
provDebugR also imports:
Once installed, load provDebugR by calling:
library("provDebugR")
To initialise the debugger with a script, call:
prov.debug.run("scriptName.R", snapshot.size = 100)
Alternatively, if you just called rdtLite's
prov.run function, you can call:
prov.debug()
Lastly, if you have the PROV-JSON provenance file, you can also call:
prov.debug.file("provJsonFileName.json")
Once the debugger has been initialised, the rest of the functions the package provides can be used.
To find out more about what each function does, please refer to the Wiki.