writeThemesXML          package:reposTools          R Documentation

_A _f_u_n_c_t_i_o_n _t_o _a_u_t_h_o_r _r_e_p_o_s_i_t_o_r_y _t_h_e_m_e _X_M_L _f_i_l_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     This function is used to generate XML files for use with
     repository 'themes'.

_U_s_a_g_e:

     writeThemesXML(themeList, repTXML = "repThemes.xml")

_A_r_g_u_m_e_n_t_s:

themeList: A list describing the set of themes for a repository.

 repTXML: The XML output filename, defaults to 'repThemes.xml'.

_D_e_t_a_i_l_s:

     The 'themeList' argument specifies the themes for a repository.
     The names of the elements correspond to the theme names, and the
     values of each element detail the structure of the theme.  Each
     element is another list which itself has three elements:
     'Description', 'Repository' and 'Packages'.  The 'Description'
     element is a character string describing the theme, and the
     'Repository' element is another character string giving the URL of
     the repository that this theme belongs to.  The 'Packages' element
     is a third list with elements which are either 'pkgInfo' objects
     or package names.

     Specifying a 'pkgInfo' object as an entry is useful if the
     repository maintainer wishes to use a particular version of a
     package in their theme.  It a simple package name is given, then
     the highest version of that particular package in the repository
     is the one that is used.

_V_a_l_u_e:

     An XML file, name specified by 'repTXML', which contains a
     description of the repository themes specified by 'themeList'.

_A_u_t_h_o_r(_s):

     Jeff Gentry

_S_e_e _A_l_s_o:

     'repositoryThemes', 'reposTheme-class', 'pkgInfo'

_E_x_a_m_p_l_e_s:

        z <- list(Theme1=list(Description="One simple test",
                              Repository="http://www.repURL.com/",
                              Packages=list("Biobase", "Ruuid", "ROC", "geneplotter")),
                  Theme2=list(Description="Another simple test",
                              Repository="http://www.repURL.com",
                              Packages=list(buildPkgInfo("annotate", "1.3.0"),
                              "genefilter", buildPkgInfo("affy", "1.3.0"))))
        ## Using tempfile() instead of default filename for example
        writeThemesXML(z, tempfile())