check_install_TMB: Check TMB is working

In nwfsc-assess/PEPtools: Tools for Stock Assessments used by the Population Ecology Program

Check TMB is working

Description

Check that the installation of TMB is working before trying to run any TMB models.

Usage

check_install_TMB()

Details

This function will generate a lot of output to your screen that can be helpful when trying to troubleshoot the installation of TMB. Most importantly, you can see the location of where your computer is trying to find make files. If you have already ran this function on your computer, then you should see ⁠make: Nothing to be done for 'all'⁠. If the installation of TMB has failed, then you will see "Error in TMB::compile(...)". The most likely culprit for it failing is a faulty installation of rtools, specifically rtools40 for R version 4.0 and 4.1 and rtools42 for R version 4.20 and greater.

Value

A single integer is returned, where zero means that your installation of rtools and TMB is good to go. I hope you get a zero! If the status is failed, then you will see "Compilation failed", a stop message generated by TMB::compile().

Author(s)

Kelli F. Johnson

See Also

• pkgbuild::find_rtools[]

Examples

# Hope for a 0
## Not run: 
check_install_TMB()

## End(Not run)
# If you get something other than 0, run
pkgbuild::find_rtools()

nwfsc-assess/PEPtools documentation built on Nov. 7, 2023, 1:33 p.m.