add_adapters_: Helper function for 'add_adapters()'

Description Usage Arguments

View source: R/adapters.R

Description

Helper function for add_adapters()

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
add_adapters_(obj, ...)

## S3 method for class 'adapters'
add_adapters_(
  obj,
  adapters,
  err_h = composerr("Error while calling 'add_adapters_()'")
)

## S3 method for class 'file_structure'
add_adapters_(
  obj,
  adapters,
  err_h = composerr("Error while calling 'add_adapters_()'")
)

## S3 method for class 'file_collection'
add_adapters_(
  obj,
  adapters,
  err_h = composerr("Error while calling 'add_adapters_()'")
)

Arguments

obj

This argument can be various different things:

  • An adapters class object. Then the adapters will be appended to this object.

  • An file_structure class object. Then the adapters will be appended to the obj$adapters attribute of the class.

  • An file_collection class object. Then the adapters will be appended to each file_definition object in the list.

...

Additional arguments

adapters

An adapters class object, which holds all adapter functions and their descriptions. This class object can be created by using the function new_adapters().

err_h

An error handler


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