How it works

library(raiden)
library(rstudioapi)
library(rlang)
library(R6)

Outline

This vignette documents how the raiden Addin locates your R objects, determines their structure, and provides the UI interface for editing the roxygen2 tags.

is.package?

Is the current directory an R package?

getwd()
#> [1] "/home/runner/work/raiden/raiden"
is_package()
#> [1] TRUE

Load objects

Let’s load some objects in the global environment:

my_list <- list('mtcars' = datasets::mtcars,
                'attitude' = datasets::attitude,
               'titanic' = datasets::Titanic)
mtcars <- datasets::mtcars
my_time <- Sys.time()
R6_class_generator <- R6Class()
R6_object <- R6_class_generator$new()

The gather_objects() function will find all objects in the global environment.

gather_objects(type = "all")
#> [1] "R6_class_generator" "R6_object"          "mtcars"            
#> [4] "my_time"            "my_list"

The gather_classes() will identify all objects in the global environment, but also return their class:

gather_classes()
#> R6_class_generator          R6_object             mtcars            my_time 
#> "R6ClassGenerator"               "R6"       "data.frame"  "POSIXct, POSIXt" 
#>            my_list 
#>             "list"

In the case that an object has multiple classes, the gather_classes() collapses these into a single character (separated by a comma (,)):