setupAD: Set Up Paths for PBSadmb

View source: R/PBSadmb.r

setupADR Documentation

Set Up Paths for PBSadmb

Description

Set up path information by reading from a pathfile (default = ADpaths.txt) and checking that certain executable files exist.

Usage

setupAD(pathfile)

Arguments

pathfile

string name of 2-column text file that details the relevant paths for the R variables admbpath, gccpath, and editor.

Details

This program is useful primarily for console-based function calls. It sets up the background options for PBSadmb functions (convAD, compAD, linkAD) by reading paths from a file and checking to make sure that they are valid (i.e., contain certain exectuable files like tpl2cpp and g++). The options are store in a PBSoptions class objects called .PBSadmb in the temporary environment .PBSadmbEnv.

Note

To access the options manager in the temporary working environment, use the PBSadmb accessor functions (atget, atput, atcall, atprint). For eample:

atprint(.PBSadmb)

On UNIX systems the MinGW compiler and UNIX tools are readily available; therefore, only the admbpath (path to ADMB's home directory) and the path to a text editor are needed.

Author(s)

Jon T. Schnute, Scientist Emeritus
Pacific Biological Station (PBS), Fisheries & Oceans Canada (DFO), Nanaimo BC
Last modified Rd: 2014-02-27

See Also

readADpaths, checkADopts, makeAD


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