Size of objects in memory

This function calculates the size of objects in the global environment of R using lobstr::obj_size and prints a summary of objects that are greater than a specified size threshold. It is useful for memory management and identifying large objects in the workspace.

Usage

AllObjSizes(GreaterThan = 0, InFunction = FALSE, SizeDecimals = 2, N = Inf)

Arguments

GreaterThan

Numeric. Size threshold in MB. Only objects larger than this value will be shown. Default is 0, which means all objects will be shown. GreaterThan must be a non-negative number.

InFunction

Logical. This controls the scope of the function. It indicates whether the execution is done inside or outside of a function. Defaults to FALSE to show sizes of objects in the global environment. If set to TRUE, sizes of objects in the function are returned.

SizeDecimals

Integer; representing the number of decimal places to show in the Size column. Defaults to 2.

N

Number of objects to show. Defaults to Inf meaning show all available objects.

Value

The function prints a tibble containing the variables' names, their sizes in MB, and their percentage of the total size of all variables. If no objects meet the criteria, a message is printed instead. Output is sorted in descending order of the size of the objects. The function also prints the total size of all variables and the number of objects that were examined.

Author

Ahmed El-Gabbas

Examples

AA1 <<- rep(seq_len(1000), 10000)
AA2 <<- rep(seq_len(1000), 100)

# All objects in memory
AllObjSizes()
#> ---------------------------------------------------
#> 	3 Object(s) fulfill the criteria
#> ---------------------------------------------------
#> # A tibble: 3 × 4
#>   Object       Class    Size Percent
#>   <chr>        <chr>   <dbl> <chr>  
#> 1 AA1          integer 38.15 99.00% 
#> 2 AA2          integer  0.38 1.00%  
#> 3 .Random.seed integer  0    0.00%  
#> Object sizes are in MB.
#> ---------------------------------------------------
#> 

# Objects larger than 1 MB
AllObjSizes(GreaterThan = 1)
#> ---------------------------------------------------
#> 	1 Object(s) fulfill the criteria
#> ---------------------------------------------------
#> # A tibble: 1 × 4
#>   Object Class    Size Percent
#>   <chr>  <chr>   <dbl> <chr>  
#> 1 AA1    integer 38.15 99.00% 
#> Object sizes are in MB.
#> ---------------------------------------------------
#> 

# Objects larger than 50 MB
AllObjSizes(GreaterThan = 50)
#> No object has Size > 50 MB
#> 

# When called with another function, it shows the objects only available
# within the function
TestFun <- function(XX = 10) {
  Y <- 20
  C <- matrix(data = seq_len(10000), nrow = 100, ncol = 100)
  AllObjSizes(InFunction = TRUE)
}

TestFun()
#> ---------------------------------------------------
#> 	3 Object(s) fulfill the criteria
#> ---------------------------------------------------
#> # A tibble: 3 × 4
#>   Object Class         Size Percent
#>   <chr>  <chr>        <dbl> <chr>  
#> 1 C      matrix_array  0.04 100.00%
#> 2 XX     numeric       0    0.00%  
#> 3 Y      numeric       0    0.00%  
#> Object sizes are in MB.
#> ---------------------------------------------------
#> 

TestFun(XX = "TEST")
#> ---------------------------------------------------
#> 	3 Object(s) fulfill the criteria
#> ---------------------------------------------------
#> # A tibble: 3 × 4
#>   Object Class         Size Percent
#>   <chr>  <chr>        <dbl> <chr>  
#> 1 C      matrix_array  0.04 100.00%
#> 2 XX     character     0    0.00%  
#> 3 Y      numeric       0    0.00%  
#> Object sizes are in MB.
#> ---------------------------------------------------
#>