work_dir: IARC CRG Tools Working Directory

In WetRobot/iarccrgtools: IARC CRG Tools Utilities

IARC CRG Tools Working Directory

Description

Get and set directory where input and output files of IARC CRG Tools are stored.

Usage

iarc_workdir_set(dir)

set_tools_work_dir(dir)

iarc_workdir_get()

get_tools_work_dir()

get_tool_work_dir(tool.name, hash)

Arguments

dir	⁠[character]⁠ (no default) Path to an existing directory. This will be the working directory.
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 an input dataset; get working directory for tool.name and this dataset.

Details

The working directory is where files for IARC CRG Tools and created by IARC CRG Tools should live. This is not the same directory where the executable for IARC CRG Tools is. Instead, the working directory is recommended to be created by you manually in advance. You may also use a temporary directory if you don't want to store any results (see base::tempdir).

The tools working directory set by iarc_workdir_set will itself be populated by tool-specific directories, e.g. "my_dir/check/" will contain results for the "check" tool.

Functions

• iarc_workdir_set(): Set working directory, directory where IARC CRG Tools input and output data will be written.

• set_tools_work_dir(): Deprecated.

• iarc_workdir_get(): Get currently set working directory for IARC CRG Tools.

• get_tools_work_dir(): Deprecated.

• get_tool_work_dir(): Deprecated.

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