internal.list.data: Build the list of data available for loading into memory

.list.dataR Documentation

Build the list of data available for loading into memory

Description

This function produces a data.frame of all data files in the project, with meta data on if and how the file will be loaded by load.project.

Usage

.list.data(config)

Arguments

config

List containing the configuration to use.

Details

The returned data.frame contains the following variables, with one observation per file in data/:

filename Character variable containing the filename relative to data/ directory.
varname Character variable containing the name of the variable into which the file will be imported. *
is_ignored Logical variable that indicates whether the file. is ignored through the data_ignore option in the configuration
is_directory Logical variable that indicates whether the file is a directory.
is_cached Logical variable that indicates whether the file is already available in the cache/ directory.
cached_only Logical variable that indicates whether the variable is only available in the cache/ directory. This occurs when calling the cache function with a code fragment in a munge script.
reader Character variable containing the name of the reader function that will be used to load the data. Contains a character(0) if no suitable reader was found.

* Note that some readers return more than one variable, usually with the listed variable name as prefix. This is true for for example the xls.reader and xlsx.reader.

Value

A data.frame listing the available data, with relevant meta data


ProjectTemplate documentation built on July 4, 2024, 1:10 a.m.