checkADopts: Check ADMB Options for Path Integrity

View source: R/PBSadmb.r

checkADoptsR Documentation

Check ADMB Options for Path Integrity

Description

Check that the options object .PBSadmb has all required components and that paths point to actual files on the hard drive.

Usage

checkADopts(opts=getOptions(atcall(.PBSadmb)),
   check=c("admbpath","gccpath","msysbin","editor"), 
   warn=TRUE, popup=FALSE, verify=TRUE)

Arguments

opts

list – ADMB options values.

check

character – components (directory paths) of .PBSadmb to check.

warn

logical – if TRUE, print the results of the check to the R console.

popup

logical – if TRUE, display program location problems in a popup GUI.

verify

logical – if TRUE, then the ‘Verify’ button in the GUI was pressed. This only affects the message generation ‘All programs found’. Command line call does not depend on GUI.

Value

Boolean value where TRUE indicates all programs were located in the specified directories and FALSE if at least one program cannot be found. The returned Boolean scalar has two attributes:
warn – named list of test results, and
message – named vector of test results.

Note

A wrapper function that can be called from a GUI exists as .win.checkADopts.

Author(s)

Rowan Haigh, Program Head – Offshore Rockfish
Pacific Biological Station (PBS), Fisheries & Oceans Canada (DFO), Nanaimo BC
locus opus: Offsite, Vancouver BC
Last modified Rd: 2018-10-03

See Also

setADpath,readADopts


PBSadmb documentation built on Nov. 11, 2023, 1:07 a.m.