btw_this.environment: Describe the contents of an environment

View source: R/tool-environment.R

btw_this.environmentR Documentation

Describe the contents of an environment

Description

Describe the contents of an environment

Usage

## S3 method for class 'environment'
btw_this(x, ..., items = NULL)

Arguments

x

An environment.

...

Additional arguments are silently ignored.

items

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

Value

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

See Also

btw_tool_env_describe_environment()

Other btw formatting methods: btw_this(), btw_this.character(), btw_this.data.frame()

Examples

env <- new.env()
env$cyl_6 <- mtcars[mtcars$cyl == 6, ]
env$gear_5 <- mtcars[mtcars$gear == 5, ]
btw_this(env)


btw documentation built on Nov. 5, 2025, 7:45 p.m.