checkFF                package:tools                R Documentation

_C_h_e_c_k _F_o_r_e_i_g_n _F_u_n_c_t_i_o_n _C_a_l_l_s

_D_e_s_c_r_i_p_t_i_o_n:

     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.

_U_s_a_g_e:

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

_A_r_g_u_m_e_n_t_s:

 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
          (and the result is returned invisibly).

_V_a_l_u_e:

     An object of class `"checkFF"', which currently is a list of the
     (parsed) foreign function calls with no `PACKAGE' argument.

     There is a `print' method for nicely displaying the information
     contained in such objects.

_W_a_r_n_i_n_g:

     This function is still experimental.  Both name and interface
     might change in future versions.

_S_e_e _A_l_s_o:

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

_E_x_a_m_p_l_e_s:

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

