checkFF                package:tools                R Documentation

Check Foreign Function Calls

Description:

     Performs checks on calls to compiled code from R code.  Currently
     only whether the interface functions such as `.C' and `.Fortran'
     are called with argument `PACKAGE' specified, which is highly
     recommended to avoid name clashes in foreign function calls.

Usage:

     checkFF(package, dir, file, lib.loc = NULL,
             verbose = getOption("verbose"))

Arguments:

 package: a character string naming an installed package.  If given,
          the installed R code of the package is checked.

     dir: a character string specifying the path to a package's root
          source directory.  This should contain the subdirectory `R'
          (for R code).  Only used if `package' is not given.

    file: the name of a file containing R code to be checked.  Used if
          neither `package' nor `dir' are given.

 lib.loc: a character vector of directory names of R libraries, or
          `NULL'.  The default value of `NULL' corresponds to all
          libraries currently known.  The specified library trees are
          used to to search for `package'.

 verbose: a logical.  If `TRUE', additional diagnostics are printed.

See Also:

     `.C', `.Fortran'; `Foreign'.

Examples:

     checkFF(package = "ts", verbose = TRUE)

