README.md

In jwons/provDebugR: An R Post-Mortem Debugger

THE OFFICIAL PROVDEBUGR REPO HAS BEEN MOVED TO A NEW REPO

The official provDebugR repo has been moved.

provDebugR

A debugging tool that leverages provenance to provide handy information about R scripts to assist in writing them.

Installation

Devtools is needed for installation:

install.packages("devtools")

Installation of all required packages (can be copied and pasted):

devtools::install_github("ProvTools/provParseR")
devtools::install_github("jwons/provGraphR")
devtools::install_github("End-to-end-provenance/RDataTracker", ref = "development")
devtools::install_github("jwons/provDebugR")

also uses: httr jsonlite * methods

and if your environment is RStudio: rstudioapi shiny * miniUI

Once installed, load the package:

library("provDebugR")

Usage

While writing a script, run the script by calling:

debug.init("yourScriptNameHere.R")

If you already have provenance stored as prov.json, you can also use that file as an argument.

debug.init("prov.json")

Once either debug.prov or debug.init is run the rest of the functions can be used. To find out more about what each function does, refer to the Wiki!

debug.init(input.data)
debug.variable.type(..., just.logical = F)
debug.from.type(variable, type)
debug.from.line(..., state = F) 
debug.lineage(..., forward = F) 
debug.error.trace(stack.overflow = F)
debug.warning.trace(..., stack.overflow = F) 
debug.browser()
debug.gadget()

jwons/provDebugR documentation built on May 3, 2019, 3:40 p.m.