All Projects → r-lib → Lobstr

r-lib / Lobstr

Licence: other
Understanding complex R objects with tools similar to str()

Programming Languages

r
7636 projects

lobstr

CRAN status R-CMD-check Codecov test coverage

lobstr provides tools in the same vein as str(), which allow you to dig into the detail of an object.

Installation

Install the released version of lobstr from CRAN:

install.packages("lobstr")

You can install the development version with:

# install.packages("devtools")
devtools::install_github("r-lib/lobstr")

Example

Abstract syntax trees

ast() draws the abstract syntax tree of R expressions:

ast(a + b + c)
#> █─`+` 
#> ├─█─`+` 
#> │ ├─a 
#> │ └─b 
#> └─c

ast(function(x = 1) {
  if (x > 0) print("Hi!")
})
#> █─`function` 
#> ├─█─x = 1 
#> ├─█─`{` 
#> │ └─█─`if` 
#> │   ├─█─`>` 
#> │   │ ├─x 
#> │   │ └─0 
#> │   └─█─print 
#> │     └─"Hi!" 
#> └─<inline srcref>

References

ref() shows hows objects can be shared across data structures by digging into the underlying __ref__erences:

x <- 1:1e6
y <- list(x, x, x)
ref(y)
#> █ [1:0x7fd174b0ea88] <list> 
#> ├─[2:0x7fd19545c878] <int> 
#> ├─[2:0x7fd19545c878] 
#> └─[2:0x7fd19545c878]

e <- rlang::env()
e$self <- e
ref(e)
#> █ [1:0x7fd174bc1bc0] <env> 
#> └─self = [1:0x7fd174bc1bc0]

A related tool is obj_size(), which computes the size of an object taking these shared references into account:

obj_size(x)
#> 680 B
obj_size(y)
#> 760 B

Call stack trees

cst() shows how frames on the call stack are connected:

f <- function(x) g(x)
g <- function(x) h(x)
h <- function(x) x
f(cst())
#>     █
#>  1. ├─global::f(cst())
#>  2. │ └─global::g(x)
#>  3. │   └─global::h(x)
#>  4. └─lobstr::cst()
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].