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())

