Documentation (original) (raw)

The TMB documentation consists of several parts:

• R functions are documented as an ordinary R package
  • You can type help(MakeADFun) in R to get help on a function.
  • The manual is available from CRAN as pdf or html.
• C++ functions
  • Referred to as API. Docs are generated directly from source code using Doxygen.
  • You need to manually run doxygen to build the docs (see main readme file).
  • There exists a precompiled version of the docs: C++ function documentation (API) corresponding to the most recent TMB version on CRAN.
  • Things you should NOT do in TMB
• Example collection When you download TMB from github (by cloning or getting the zip file) you automatically get a large collection of examples.
  • Examples are placed in the folder tmb_examples.
  • Each example has two parts: .R and .cpp file.
  • To run the mvrw example, say, type in R: source("mvrw.R").
  • Another list of examples can be found here
• Book The comprehensive TMB documentation.
• Videos TMB tutorials.