str.Flow: Compactly display the content of a Flow object

View source: R/str.Flow.R

str.FlowR Documentation

Compactly display the content of a Flow object

Description

Print short informative strings about the Flow object and all it contains, plus possibly, inheritance information.

Usage

## S3 method for class 'Flow'
str(
  object,
  max.level = 1L,
  nest.lev = 0L,
  indent.str = paste(rep.int(" ", max(0L, nest.lev + 1L)), collapse = ".."),
  ...
)

Arguments

object

A Flow object.

max.level

The maximum nesting level to use for displaying nested structures.

nest.lev

Used internally for pretty printing nested objects (you probably don't want to change default value).

indent.str

Idem.

...

Further arguments passed to str() methods of Flow items.

See Also

flow

Examples

# A Flow object
data(iris)
fl <- flow(iris, x = 1:10, var_ = Sepal.Length)
fl # Shows the .value contained into fl
str(fl) # Provides compact information about satellite data contained in fl

SciViews/flow documentation built on Sept. 9, 2023, 10:22 a.m.