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)

