testInstalledPackage          package:tools          R Documentation

_T_e_s_t _I_n_s_t_a_l_l_e_d _P_a_c_k_a_g_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     These functions allow an installed package to be tested, or all
     base and recommended packages.

_U_s_a_g_e:

     testInstalledPackage(pkg, lib.loc = NULL, outDir = ".",
                          types = c("examples", "tests", "vignettes"))

     testInstalledPackages(outDir = ".", errorsAreFatal = TRUE,
                           scope = c("both", "base", "recommended"),
                           types = c("examples", "tests", "vignettes"))

     testInstalledBasic(scope = c("basic", "devel", "both"))

_A_r_g_u_m_e_n_t_s:

     pkg: name of an installed package.

 lib.loc: library path(s) in which to look for the package.  See
          'library'.

  outDir: the directory into which to write the output files: this
          should already exist.

   types: type(s) of tests to be done.

errorsAreFatal: logical: should testing terminate at the first error?

   scope: Which set(s) should be tested?

_D_e_t_a_i_l_s:

     These tests depend on having the package example files installed
     (which is the default).  If package-specific tests are found in a
     'tests' directory they can be tested: these are not installed by
     default, but will be if 'R CMD INSTALL --install-tests' was used. 
     Finally, the R code in any vignettes can be extracted and tested.

     Package tests are run in a 'pkg-tests' subdirectory of 'outDir',
     and leave their output there.

     'testInstalledBasic' runs the basic tests, if installed.  This
     should be run with 'LC_COLLATE=C' set: the function tries to set
     this by it may not work on all OSes.

     The package-specific tests for the base and recommended packages
     are not normally installed, but 'make install-tests' is provided
     to do so (as well as the basic tests).

_V_a_l_u_e:

     Invisbly '0L' for success, '1L' for failure.

