templateDescriptionFile       package:cellHTS2       R Documentation

_C_r_e_a_t_e_s _a _t_e_m_p_l_a_t_e _d_e_s_c_r_i_p_t_i_o_n _f_i_l_e _f_o_r _a_n _R_N_A_i _e_x_p_e_r_i_m_e_n_t

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

     This function creates a template description file for an RNAi
     experiment with default entries compliant with MIAME class  and
     with additional entries specific for a 'cellHTS' object.

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

       templateDescriptionFile(filename="Description.txt", path, force=FALSE)

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

filename: the name of the output file. Default is "Description.txt".

    path: a character of length 1 indicating the path in which to
          create the screen description file.  By default, it can
          extract the path from 'filename'.

   force: a logical value, determines the behaviour of the function if
          file 'filename' exists. If 'force' is 'TRUE', the function
          overwrites 'filename', otherwise it casts an error.

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

     This function can be called to generate a template file for the
     RNAi experiment.  This file contains the fields that are compliant
     with the 'MIAME' class and also additional entries specific for
     the  'cellHTS' class, which should be edited and completed by the
     user.

     This file, which we call _Screen description file_, is required to
     configure the 'cellHTS' object via function 'configure'. It is
     intended to contain general information about the screen, such as
     its title, its goal, when and how it was performed, which
     organism, which library, type of assay, references, and any other
     information that is pertinent to the biological interpretation of
     the experiments.

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

     The function returns a character with the full path and name of
     the file that was created.

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

     Ligia Bras ligia@ebi.ac.uk

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

     'configure'

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

       out <- templateDescriptionFile("Description.txt", path=tempdir())
       out
       readLines(out)

