limmaUsersGuide            package:limma            R Documentation

_V_i_e_w _L_i_m_m_a _U_s_e_r'_s _G_u_i_d_e

_D_e_s_c_r_i_p_t_i_o_n:

     Finds the location of the Limma User's Guide and optionally opens
     it.

_U_s_a_g_e:

     limmaUsersGuide(view=TRUE)

_A_r_g_u_m_e_n_t_s:

    view: logical, should the document be opened using the default PDF
          document reader?

_D_e_t_a_i_l_s:

     The function 'vignette("limma")' will find the short limma
     Vignette which describes how to obtain the Limma User's Guide. The
     User's Guide is not itself a true vignette because it is not
     automatically generated using 'Sweave' during the package build
     process. This means that it cannot be found using 'vignette',
     hence the need for this special function.

     If the operating system is other than Windows, then the PDF viewer
     used is that given by 'Sys.getenv("R_PDFVIEWER")'. The PDF viewer
     can be changed using 'Sys.putenv(R_PDFVIEWER=)'.

     This function is used by drop-down Vignettes menu when the Rgui
     interface for Windows is used.

_V_a_l_u_e:

     Character string giving the file location.

_A_u_t_h_o_r(_s):

     Gordon Smyth

_S_e_e _A_l_s_o:

     'vignette', 'openPDF', 'openVignette', 'Sys.getenv', 'Sys.putenv'

_E_x_a_m_p_l_e_s:

     limmaUsersGuide(view=FALSE)