Read File Metadata from YAML-File — read_file_metadata • kwb.file

Read File Metadata from YAML-File

read_file_metadata(
  yaml_file,
  file_encoding = "UTF-8",
  out_class = c("data.frame", "list")[1]
)

Arguments

yaml_file: path to YAML-File containing file metadata (as saved with kwb.file:::write_file_info_to_yaml_file)
file_encoding: passed to argument fileEncoding of read_yaml
out_class: one of "data.frame", "list"

Value

depending on out_class, either a data frame with the following columns or a list with the following elements is returned:

file_id: clean file name given to the original file for simpler access,
original_name: original file name given by data provider,
original_folder: original path to folder in which file was provided.