Skip to contents

Format an iface specification for printing

Source: R/iface-class.R
format.iface.Rd

Format an iface specification for printing

Usage

# S3 method for iface
format(x, ...)

Arguments

x

an iface specification

...

not used.

Value

a formatted string representation of an iface

Examples

my_iface = iface( 
  col1 = integer + group_unique ~ "an integer column"
)

print(my_iface)
#> A dataframe containing the following columns: 
#> * col1 (integer + group_unique) - an integer column
#> No mandatory groupings.
#> No default value.
knitr::knit_print(my_iface)
#> [1] "A dataframe containing the following columns: \n\n* col1 (integer + group_unique) - an integer column\n\nNo mandatory groupings.\n\nNo default value."
#> attr(,"class")
#> [1] "knit_asis"