WhatIs: Investigate data objects

In BrailleR: Improved Access for Blind Users

Investigate data objects

Description

Investigate an object, especially useful at any stage in a pipe chain.

Usage

CheckIt(x, ...)
check_it(x, ...)

what_is(x, ...)
WhatIs(x, ...)

Arguments

x	The object to be investigated and passed out again.
...	extra parameters to be passed on.

Details

The VI() functionality returns a character vector and is not useful inside a pipe chain. In effect, WhatIs() just adds the pipe chain convenience to the VI() tool, while CheckIt() looks at the structure of the data object. The latter is perhaps more useful if you are uncertain that the pipe chain is delivering what you hoped for.

Value

These functions intentionally return (invisibly of course) the original input object so that they can be used within a pipe chain, as is commonly used by the Tidyverse.

Author(s)

A. Jonathan R. Godfrey

Examples

require(dplyr)
airquality %>% CheckIt() %>% arrange(Ozone) %>% head()

BrailleR documentation built on July 26, 2023, 5:46 p.m.