vExplorer             package:tkWidgets             R Documentation

_A_n _i_n_t_e_r_f_a_c_e _t_o _i_n_t_e_r_a_c_t _w_i_t_h _v_i_g_n_e_t_t_e _c_o_d_e _c_h_u_n_k_s

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

     This function provides a widget for viewing, editing, and
     executing code chunks of vignettes.

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

     vExplorer(title = "BioC Vignettes Browser", pkgName = "",  font =
     ifelse(.Platform$OS.type  == "unix", "arial 14", "arial 11"))
     viewVignette(title, packName, vigPath, pdfPath, font = "arial 11")

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

   title: character string for the name to be displayed as the title of
          the widget to interact with code chunks.

 pkgName: vector (of length 1 for 'pkgName') of character strings for
          names of Bioconductor packages the code chunks of whose
          vignettes will be explored.

packName: same as pkgName

 vigPath: character string for the full qualified name of a vignette to
          be explored.

 pdfPath: character string for the full path of a pdf file (if any)
          associated with a vignette.

    font: a character string for the name and size of the font to be
          used for text rendered on the widgets (e. g. "arial 11")

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

     By default, 'packNames = ""', all the installed packages will be
     examined and those that have vignettes will be listed to allow
     users to choose from.

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

     This function does not return any useful value.

_N_o_t_e:

     This function is part of the Bioconductor project at Dana-Faber
     Cancer Institute to provide Bioinformatics functionalities through
     R.

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

     Jianhua Zhang

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

     <URL: http://www.bioconductor.org>

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

     if(interactive()){
         require(DynDoc)
         require(tools)
         require(widgetTools)
         vExplorer()
         path <- .path.package("widgetTools")
         vigList <- getPkgVigList(path)
         viewVignette("BioC VignetteBrowser", "widgetTools", vigList[[1]]$VigPath,
          file.path(path, "doc"))
     }

