Skip to contents

Tool: Describe an environment

Usage

btw_tool_env_describe_environment(
  items = NULL,
  ...,
  environment = global_env()
)

Arguments

items

Optional. A character vector of objects in the environment to describe.

...

Ignored.

environment

An environment to describe.

Value

A string describing the environment contents with #> prefixing each object's printed representation.

Examples

my_cars <- mtcars[mtcars$mpg > 25, ]
 btw_tool_env_describe_environment("my_cars")
#> <btw::BtwToolResult>
#>  @ value  : NULL
#>  @ error  : NULL
#>  @ extra  : list()
#>  @ request: NULL