get_meta_: Helper function for 'get_meta()'

Description Usage Arguments Value

View source: R/meta.R

Description

Retrieve all meta information for a single or multiple data columns and store it in a data.frame.

Usage

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

## S3 method for class 'file_structure'
get_meta_(
  obj,
  cols = NULL,
  err_h = composerr("Error while calling 'get_meta_()'"),
  ...
)

## S3 method for class 'data.frame'
get_meta_(
  obj,
  cols = NULL,
  err_h = composerr("Error while calling 'get_meta_()'"),
  ...
)

## S3 method for class 'file_collection'
get_meta_(
  obj,
  cols = NULL,
  err_h = composerr("Error while calling 'get_meta_()'"),
  ...
)

Arguments

obj

A file_structure class object or a file_definition class object or a file_collection class object or a data.frame generated by the read_data() function (holds the meta information as attribute). The meta information will be extracted from this object.

...

Additional arguments

cols

An optional object, defining for which columns the meta information should be retrieved. It can either be a character vector, holding the names of the columns of interest, or it can be numeric vector holding the indices of the columns of interest. If cols is omitted, then all columns are used.

err_h

An error handler

Value

Returns a data.frame holding all meta information.


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