get_adapter_desc: Get Description of adapter function

Description Usage Arguments Value adapters

View source: R/adapters.R

Description

Get Description of adapter function

Usage

1
get_adapter_desc(adapters, i)

Arguments

adapters

An adapters class object holding the adapter functions, which should be applied to the data.frame.

i

The list index of the adapter function in the adapters class object.

Value

A string holding the description

adapters

An adapter function is a function that takes a data.frame as input argument and returns a modified version of this data.frame. The adapter functions are stored in an adapters class object, which is a special list that contains all adapter functions and a description text of each function. This class objects can be created by using the function new_adapters(). The adapters class objects can be added to a file_structure or a file_definition or a file_collection class object. After reading a data file (by calling read_data(file_definition)) all adapter functions listed in the adapters argument of the file_definition]new_file_definition() class object will be applied consecutively to the loaded data set. Adapter functions can be added to an existing file_structure or a file_definition or a file_collection class object by using the function add_adapters(). Adapter functions can be used for several tasks:


a-maldet/readall documentation built on Dec. 18, 2021, 9:23 p.m.