iarc_output_read: IARC CRG Tools Output

In WetRobot/iarccrgtools: IARC CRG Tools Utilities

IARC CRG Tools Output

Description

Read IARC CRG Tools output into R.

Usage

iarc_output_read(tool.name, hash, input.col.nms = NULL, verbose = TRUE)

read_tools_results(tool.name, hash, input.col.nms = NULL, verbose = TRUE)

Arguments

tool.name	⁠[character]⁠ (mandatory, no default) name of tool to run; see output of tool_clean_names() for options
hash	⁠[character]⁠ (no default) Hash of input dataset to read into R. See ⁠[iarccrgtools::cache_hash]⁠.
input.col.nms	NULL (default) or a character string vector of column names; when not NULL, allows setting column names on the tables that were read. See Details.
verbose	if TRUE, this function gives messages during its process

Details

When input.col.nms is a character string vector, it is attempted to be used as the set of column names for any tables that are read by this function. You should supply the same column names that were in the file saved for use by IARC CRG Tools. If IARC CRG Tools adds a column in addition to the ones you had in input data, that column will gain the name "tool_text" automatically.

Value

A list of data.frames (where the read file was a table) and/or character string vectors (where the read file was a non-table file such as a log file). The names of the list correspond to the names of the files that were read.

Functions

• read_tools_results(): Deprecated — use iarccrgtools::iarc_output_read.

WetRobot/iarccrgtools documentation built on Feb. 1, 2024, 6:33 a.m.