interfacer (version 0.3.3)

iconvert: Convert a dataframe to a format compatible with an interface specification

Description

This function is called by ivalidate() and is not generally intended to be used directly by the end user. It may be helpful in debugging during package development to interactive test a iface spec. iconvert is an interactive version of ivalidate().

Usage

iconvert(
  df,
  iface,
  .imap = interfacer::imapper(),
  .dname = "",
  .fname = "",
  .has_dots = TRUE,
  .prune = FALSE,
  .env = rlang::current_env()
)

Value

the input dataframe coerced to be conformant to the iface

specification, or an informative error is thrown.

Arguments

df

the dataframe to convert

iface

the interface spec as an iface

.imap

an optional imapper mapping

.dname

the name of the parameter value (optional).

.fname

the name of the function (optional).

.has_dots

internal library use only. Changes the nature of the error message.

.prune

do you want to remove non matching columns?

.env

internal use only

Examples

i_diamonds = iface( 
  color = enum(D,E,F,G,H,I,J,extra) ~ "the colour", 
  price = integer ~ "the price"
)

iconvert(ggplot2::diamonds, i_diamonds,.prune = TRUE)