calibReadMe              package:CALIB              R Documentation

_V_i_e_w _C_A_L_I_B _r_e_a_d_m_e _f_i_l_e

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

     Finds the location of the CALIB readme file and optionally opens
     it.

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

     calibReadMe(view = TRUE)

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

    view: logical, 'TRUE' means open the readme file and 'FALSE' means
          finds out the location of the file only.

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

     The function 'vignette("limma")' will find the short CALIB 
     vignette which describes how to obtain the CALIB readme file.  The
     readme file is not 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 the one given by 'Sys.getenv("R_PDFVIEWER")'.  The PDF
     viewer can be changed using 'Sys.putenv(R_\PDFVIEWER=)'.

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

     Character string giving the file location.

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

     Hui Zhao

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

     'limmaUsersGuide' in the limma package

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

     calibReadMe(view=FALSE)

