Tool: Describe an environment

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.

See also

btw_this.environment(), btw_tools()

Other Tools: btw_tool_docs_package_news(), btw_tool_env_describe_data_frame(), btw_tool_files_list_files(), btw_tool_files_read_text_file(), btw_tool_files_write_text_file(), btw_tool_ide_read_current_editor(), btw_tool_package_docs, btw_tool_search_packages(), btw_tool_session_package_info(), btw_tool_session_platform_info(), btw_tool_web_read_url(), btw_tools()

Examples

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