Generate aux_version string for script-based analyses with IQR Tools

The function creates an "aux_version()" character string to be used in the analysis script.

gen_aux_version(
  pkgName = "IQRtools",
  automode = TRUE,
  exactVersion = TRUE,
  IQdesktop = TRUE,
  Rversion = TRUE,
  isRopen = TRUE,
  OS = TRUE
)

Arguments

pkgName

The name of the package for which a certain version is required

automode

Logical. Automatically determine which fields to return. If on IQdesktop, only IQdesktop is returned otherwise exactVerion, Rversion, isRopen and OS are returned.

exactVersion

Logical. Create the "exactVersion" field. Default is TRUE. Only used if automode = FALSE.

IQdesktop

Logical. Create the "IQdesktop" field. Default is TRUE. Only used if automode = FALSE.

Rversion

Logical. Create the "Rversion" field. Default is TRUE. Only used if automode = FALSE.

isRopen

Logical. Create the "isRopen" field. Default is FALSE. Only used if automode = FALSE.

OS

Logical. Create the "OS" field. Default is FALSE. Only used if automode = FALSE.

Value

Character string following the notation of aux_version.

Details

Analyses conducted according to the IntiQuan guidelines are required to contain an aux_version() statement indicating the version if IQRtools used and stating details of the development environment such as the IQdesktop version, R version, etc.. See aux_version for more details.

See also