fx_info: Effex Function: Information

Description Usage Arguments Methods (by generic) Extension Mechanism

Description

This function provides versatile information on the different variables. fx_output() turns this information into a string.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## S3 method for class 'fxd_info_stats'
fxe_info(data, topic, statistics, ...)

## S3 method for class 'fxd_info_title'
fxe_info(data, topic, ...)

fx_info(data, topic, ...)

fxe_info(data, topic, ...)

## S3 method for class 'fxd_info'
fxe_info(data, topic, ...)

Arguments

data

A dataframe, possibly with a metaframe

topic

The topic of the information

statistics

a character vector or a list of characters and functions. Function slots must have a name. Functions can accept arguments from metaframe columns. The corresponding column will be fed in first and there will be an additional data column with the entire data. All arguments but the column will only be fed into functions, not characters.

fxInfo_title

character, NULL or list of both. If

arguments

for the information methods

Methods (by generic)

Extension Mechanism

An extension may be defined via fxe_info() which dispatches over fxd("info", topic).


sflippl/tectr documentation built on May 6, 2019, 8:51 a.m.