README.md

In ProvTools/provDebugR: A Time-Travelling Debugger

provDebugR

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.

Installation

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: httr igraph jsonlite methods testthat textutils

Once installed, load provDebugR by calling:

library("provDebugR")

Usage

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. debug.error debug.line debug.lineage debug.state debug.type.changes debug.variable * debug.warning

ProvTools/provDebugR documentation built on April 29, 2021, 7:22 p.m.