• Stars
    star
    144
  • Rank 241,566 (Top 5 %)
  • Language
    R
  • License
    Other
  • Created over 7 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Easy and efficient debugging for R packages

debugme

Debug R Packages

Linux Build Status Windows Build status CRAN RStudio mirror downloads Coverage Status

Specify debug messages as special string constants, and control debugging of packages via environment variables. This package was largely influenced by the debug npm package.

Installation and Usage

install.packages("debugme")

To use debugme in your package, import it, and then add the following .onLoad function to your package:

.onLoad <- function(libname, pkgname) {
  debugme::debugme()
}

You can now add debug messages via character literals. No function calls are necessary. For example:

"!DEBUG Start up phantomjs"
private$start_phantomjs(phantom_debug_level)

"!DEBUG Start up shiny"
private$start_shiny(path)

"!DEBUG create new phantomjs session"
private$web <- session$new(port = private$phantom_port)

"!DEBUG navigate to Shiny app"
private$web$go(private$get_shiny_url())

The string literals are simply ignored when debugging is turned off. To turn on debugging for a package, set the environment variable DEBUGME to the package name you want to debug. E.g. from a bash shell:

export DEBUGME=mypackage

Or from within R:

Sys.setenv(DEBUGME = "mypackage")

Separate multiple package names with commas:

export DEBUGME=mypackage,otherpackage

The debug messages will be prefixed by the package names, and assuming your terminal supports color, will be colored differently for each package.

Example

Dynamic code

The debugme debug strings may contain R code between backticks. This code is evaluated at runtime, if debugging is turned on. A single debug string may contain multiple backticked code chunks:

"!DEBUG x = `x`, y = `y`"
if (x != y) {
...

Motivation

I have always wanted a debugging tool that

  • is very simple to use,
  • can be controlled via environment variables, without changing anything it the packages themselves,
  • has zero impact on performance when debugging is off.

debugme is such a tool.

Performance

Function calls are relatively cheap in R, but they still do have an impact. If you never want to worry about the log messages making your code slower, you will like debugme. debugme debug strings have practically no performance penalty when debugging is off.

Here is a simple comparison to evaluate debugging overhead with a function call, f1(), debugging with debug strings, f2(), and no debugging at all.

debug <- function(msg) { }
f1 <- function() {
  for (i in 1:100) {
    debug("foobar")
    # Avoid optimizing away the loop
    i <- i + 1
  }
}
f2 <- function() {
  for (i in 1:100) {
    "!DEBUG foobar"
    # Avoid optimizing away the loop
    i <- i + 1
  }
}
f3 <- function() {
  for (i in 1:100) {
    # Avoid optimizing away the loop
    i <- i + 1
  }
}
microbenchmark::microbenchmark(f1(), f2(), f3())
#> Unit: microseconds
#>  expr    min      lq      mean median      uq       max neval cld
#>  f1() 19.585 20.8030 189.88149 21.718 23.5735 16721.969   100   a
#>  f2()  4.988  5.8665  26.00780  7.314  9.5685  1777.398   100   a
#>  f3()  4.513  5.4030  25.57436  6.354  8.3195  1793.295   100   a

License

MIT ยฉ Gรกbor Csรกrdi

More Repositories

1

devtools

Tools to make an R developer's life easier
R
2,336
star
2

lintr

Static Code Analysis for R
R
1,135
star
3

httr

httr: a friendly http package for R
R
975
star
4

actions

GitHub Actions for the R community
JavaScript
868
star
5

testthat

An R ๐Ÿ“ฆ to make testing ๐Ÿ˜€
R
849
star
6

usethis

Set up commonly used ๐Ÿ“ฆ components
R
798
star
7

pkgdown

Generate static html documentation for an R package
R
686
star
8

styler

Non-invasive pretty printing of R code
R
674
star
9

pak

A fresh approach to package installation
C
575
star
10

cli

Tools for making beautiful & useful command line interfaces
R
571
star
11

roxygen2

Generate R package documentation from inline R comments
R
554
star
12

rig

The R Installation Manager
Rust
492
star
13

rlang

Low-level API for programming with R
R
470
star
14

progress

Progress bar in your R terminal
R
447
star
15

R6

Encapsulated object-oriented programming for R
R
393
star
16

here

A simpler way to find your files
R
387
star
17

scales

Tools for ggplot2 scales
R
379
star
18

fs

Provide cross platform file operations based on libuv.
C
353
star
19

covr

Test coverage reports for R
R
327
star
20

rex

Friendly regular expressions for R.
R
323
star
21

crayon

๐Ÿ–๏ธ R package for colored terminal output โ€” now superseded by cli
R
321
star
22

memoise

Easy memoisation for R
R
312
star
23

remotes

Install R packages from GitHub, GitLab, Bitbucket, git, svn repositories, URLs
R
309
star
24

lobstr

Understanding complex R objects with tools similar to str()
R
295
star
25

callr

Call R from R
R
282
star
26

vctrs

Generic programming with typed R vectors
C
272
star
27

waldo

Find differences between R objects
R
272
star
28

slider

Sliding Window Functions
R
267
star
29

zeallot

Variable assignment with zeal! (or multiple, unpacking, and destructuring assignment in R)
R
245
star
30

conflicted

An alternative conflict resolution strategy for R
R
242
star
31

bench

High Precision Timing of R Expressions
R
237
star
32

gmailr

Access the Gmail RESTful API from R.
R
234
star
33

processx

Execute and Control Subprocesses from R
R
225
star
34

httr2

Make HTTP requests and process their responses. A modern reimagining of httr.
R
213
star
35

xml2

Bindings to libxml2
R
213
star
36

asciicast

Turn R scripts into terminal screencasts
R
211
star
37

gh

Minimalistic GitHub API client in R
R
210
star
38

cpp11

cpp11 helps you to interact with R objects using C++ code.
C++
187
star
39

keyring

๐Ÿ” Access the system credential store from R
R
185
star
40

vdiffr

Visual regression testing and graphical diffing with testthat
C++
178
star
41

svglite

A lightweight svg graphics device for R
C++
177
star
42

pillar

Format columns with colour
R
173
star
43

ragg

Graphic Devices Based on AGG
C++
169
star
44

withr

Methods For Temporarily Modifying Global State
R
166
star
45

hugodown

Make websites with hugo and RMarkdown
R
163
star
46

ymlthis

write YAML for R Markdown, bookdown, blogdown, and more
R
162
star
47

coro

Coroutines for R
R
146
star
48

rprojroot

Finding files in project subdirectories
R
146
star
49

available

Check if a package name is available to use
R
141
star
50

ellipsis

Tools for Working with ...
R
138
star
51

archive

R bindings to libarchive, supporting a large variety of archive formats
C++
138
star
52

gert

Simple git client for R
C
136
star
53

itdepends

R
133
star
54

later

Schedule an R function or formula to run after a specified period of time.
C++
132
star
55

rray

Simple Arrays
R
130
star
56

isoband

isoband: An R package to generate contour lines and polygons.
C++
130
star
57

fastmap

Fast map implementation for R
C++
128
star
58

prettyunits

Pretty, human readable formatting of quantities
JavaScript
126
star
59

desc

Manipulate DESCRIPTION files
R
120
star
60

tidyselect

A backend for functions taking tidyverse selections
R
120
star
61

gargle

Infrastructure for calling Google APIs from R, including auth
R
111
star
62

rcmdcheck

Run R CMD check from R and collect the results
R
110
star
63

evaluate

A version of eval for R that returns more information about what happened
R
107
star
64

mockery

A mocking library for R.
R
100
star
65

prettycode

Syntax highlight R code in the terminal
R
99
star
66

sloop

S language OOP โ›ต๏ธ
R
99
star
67

pkgdepends

R Package Dependency Resolution
R
93
star
68

revdepcheck

R package reverse dependency checking
R
93
star
69

clock

A Date-Time Library for R
R
93
star
70

systemfonts

System Native Font Handling in R
C++
91
star
71

lifecycle

Manage the life cycle of your exported functions and arguments
R
91
star
72

gtable

The layout packages that powers ggplot2
R
85
star
73

askpass

Password Entry for R, Git, and SSH
R
83
star
74

rappdirs

Find OS-specific directories to store data, caches, and logs. A port of python's AppDirs
R
81
star
75

zip

Platform independent zip compression via miniz
C
81
star
76

tree-sitter-r

C
81
star
77

commonmark

High Performance CommonMark and Github Markdown Rendering in R
C
81
star
78

downlit

Syntax Highlighting and Automatic Linking
R
80
star
79

clisymbols

Unicode symbols for CLI applications, with fallbacks
R
74
star
80

ps

R package to query, list, manipulate system processes
C
72
star
81

sessioninfo

Print Session Information
R
72
star
82

pkgapi

Create a map of functions for an R package - WORK IN PROGRESS!
R
70
star
83

credentials

Tools for Managing SSH and Git Credentials
R
69
star
84

roxygen2md

Convert elements of roxygen documentation to markdown
R
69
star
85

sodium

R bindings to libsodium
R
68
star
86

backports

Reimplementations of Functions Introduced Since R-3.0.0
R
65
star
87

pkgbuild

Find tools needed to build R packages
R
65
star
88

cliapp

Rich Command Line Applications
R
62
star
89

generics

Common generic methods
R
60
star
90

webfakes

Fake web apps for HTTP testing R packages
C
60
star
91

diffviewer

HTML widget to visually compare files
JavaScript
56
star
92

liteq

Serverless R message queue using SQLite
R
55
star
93

pkgload

Simulate installing and loading a package
R
55
star
94

cachem

Key-value caches for R
R
53
star
95

carrier

Create standalone functions for remote execution
R
49
star
96

brio

Basic R Input Output
R
49
star
97

jose

Javascript Object Signing and Encryption for R
R
47
star
98

urlchecker

Run CRAN URL checks from older versions of R
R
46
star
99

pkgconfig

Private configuration for R packages
R
40
star
100

filelock

Cross platform file locking in R
R
39
star