pExplorer             package:tkWidgets             R Documentation

_A _w_i_d_g_e_t _t_o _e_x_p_l_o_r_e _R _p_a_c_k_a_g_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     This widget allows users to explore R packages in the R library
     and try the example code.

_U_s_a_g_e:

     pExplorer(pkgName = "", pkgPath = "", exclude = getExclude(), getFocus =
     TRUE)
     getPkgContents(pkgName, exclude = getExclude())
     getFileContents(path, fileName)
     getExclude()
     getRPkgs(pkgPath)
     hasDesc(pkgPath)
     procRda(fileName)
     procHelp(fileName)
     procPDF(fileName)
     procHTML(fileName)

_A_r_g_u_m_e_n_t_s:

 pkgPath: 'pkgPath' a character string for the path where R packages
          are loacted

    path: 'path' a character string for the path of a given file

 pkgName: 'pkgName' a character string for the name (including path) of
          an R package to be explored

fileName: 'fileName' a character string for the name (including path)
          of a file of interest

 exclude: 'exclude' a vector of character strings containing the
          directory or file names that will not be available for
          explorering. Package names have to have a system file
          separator appanded to the end (e. g. "/" under Unix)

getFocus: 'getFocus' a boolean indicating whether a widget should grab
          the focus

_D_e_t_a_i_l_s:

     With or without a package name, the widget will have all the
     installed R package names in a dropdown list for user to select.
     As the default, the first element from 'list.files' will be
     selected and the contents displayed if no package name is given.

     'getPkgContents' gets the contents of a given R package and
     'getFileContents' gets the contents of a givan file.

     'getRPkgs', 'hasDesc', 'procRda', 'procHelp', 'procPDF', and
     'procHTML' are functions called by 'pExplorer' to process
     different file or directory types.

_V_a_l_u_e:

     The widget returns invisiable()

_N_o_t_e:

     The functions are part of the Bioconductor project at Dana-Farber
     Cancer Institute to provide Bioinfomatics functionalities through
     R

_A_u_t_h_o_r(_s):

     Jianhua Zhang

_R_e_f_e_r_e_n_c_e_s:

     Documentation on R packages

_S_e_e _A_l_s_o:

     'eExplorer'

_E_x_a_m_p_l_e_s:

         require("tkWidgets") || stop("tkWidgets not available")
         getPkgContents(.libPaths(), "tkWidgets")
         getFileContents(file.path(.path.package("tkWidgets"), "help"),
             list.files(file.path(.path.package("tkWidgets"), "help"))[1])
         if(interactive()){
             pExplorer()
         }

