Package index • interfacer

Interface specification

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

idispatch(): Dispatch to a named function based on the characteristics of a dataframe

iface(): Construct an interface specification

igroup_process(): Handle unexpected additional grouping structure

imapper(): Specify mappings that can make dataframes compatible with an iface specification

iproto(): Generate a zero length dataframe conforming to an iface specification

ireturn(): Check a return parameter from a function

is.iface(): Check if an object is an interface specification

itest(): Test dataframe conformance to an interface specification.

ivalidate(): Perform interface checks on dataframe inputs using enclosing function formal parameter definitions

Type coercion rules

type.anything(): Coerce to an unspecified type

type.character(): Coerce to a character.

type.complete(): Coerce to a complete set of values.

type.date(): Coerce to a Date.

type.default(): Set a default value for a column

type.double(): Coerce to a double.

type.enum(): Define a conformance rule to match a factor with specific levels.

type.factor(): Coerce to a factor.

type.finite(): Check for non-finite values

type.group_unique(): Coerce to a unique value within the current grouping structure.

type.in_range(): Define a conformance rule to confirm that a numeric is in a set range

type.integer(): Coerce to integer

type.logical(): Coerce to a logical

type.not_missing(): Check for missing values

type.numeric(): Coerce to a numeric.

type.of_type(): Check for a given class

type.positive_double(): Coerce to a positive double.

type.positive_integer(): Coerce to a positive integer.

type.proportion(): Coerce to a number between 0 and 1

type.unique_id(): A globally unique ids.

Parameter consistency checks

check_character(): Checks a set of variables can be coerced to a character and coerces them

check_consistent(): Check function parameters conform to a set of rules

check_date(): Checks a set of variables can be coerced to a date and coerces them

check_integer(): Checks a set of variables can be coerced to integer and coerces them

check_logical(): Checks a set of variables can be coerced to a logical and coerces them

check_numeric(): Checks a set of variables can be coerced to numeric and coerces them

check_single(): Checks a set of variables are all of length one

recycle(): Strictly recycle function parameters

resolve_missing(): Resolve missing values in function parameters and check consistency

Roxygen documentation

iclip(): Create an iface specification from an example dataframe

idocument(): Document an interface contract for inserting into roxygen2

roxy_tag_parse(<roxy_tag_iparam>): Parser for @iparam tags

roxy_tag_rd(<roxy_tag_iparam>): Support for @iparam tags

use_dataframe(): Use a dataframe in a package including structure based documentation

use_iface(): Generate interfacer code for a dataframe

Others

as.list(<iface>): Cast an iface to a plain list.

format(<iface>): Format an iface specification for printing

if_col_present(): Execute a function or return a value if a column in present in a dataframe

is_col_present(): Check for existence of a set of columns in a dataframe

knit_print.iface(): Format an iface specification for printing

print(<iface>): Format an iface specification for printing

switch_pipeline(): Branch a dplyr pipeline based on a set of conditions