tool_settings: IARC CRG Tools Settings

In WetRobot/iarccrgtools: IARC CRG Tools Utilities

IARC CRG Tools Settings

Description

Tools to handle settings files included in this package. You almost certainly do not need to use any of this functions yourself. Instead, other functions in this package use them.

Usage

tool_settings_source_dir_path()

tool_settings_availability()

tool_settings_are_available(colnameset.name)

tool_settings_copy(tgt.dir.path, colnameset.name, verbose = TRUE)

Arguments

colnameset.name	one of the items returned by tool_colnameset_names
tgt.dir.path	⁠[character]⁠ (no default) Path to an existing directory.
verbose	⁠[logical]⁠ (default TRUE) If TRUE, a message is emitted concerning what was copied where, if anything.
dir.path	a character string; a path to a directory (that must exist)

Functions

⁠[iarccrgtools::tool_settings_source_dir_path]⁠ returns a string, the location of the settings files inside this R package.

⁠[iarccrgtools::tool_settings_availability]⁠ returns a data.table with columns file_name, file_path, colnameset_name, tool_name. This dataset describes for which column name sets a settings file is available in this R package.

⁠[iarccrgtools::tool_settings_are_available]⁠ returns a TRUE if a settings file is available for colnameset.name within this R package.

⁠[iarccrgtools::tool_settings_copy]⁠ copies the settings file(s) from within this R package to tgt.dir.path.

Examples

# iarccrgtools::tool_settings_source_dir_path
stopifnot(
  dir.exists(iarccrgtools::tool_settings_source_dir_path())
)


# iarccrgtools::tool_settings_availability
stopifnot(
  is.data.frame(iarccrgtools::tool_settings_availability())
)


# iarccrgtools::tool_settings_are_available
stopifnot(
  iarccrgtools::tool_settings_are_available("mandatory_check"),
  iarccrgtools::tool_settings_are_available("all_multiple_primary"),
  iarccrgtools::tool_settings_are_available("mandatory_icdo3_to_icd10")
)

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