genRepos             package:reposTools             R Documentation

_A _f_u_n_c_t_i_o_n _t_o _c_r_e_a_t_e _a _r_e_p_o_s_i_t_o_r_y

_D_e_s_c_r_i_p_t_i_o_n:

     This functionality provides the user with the means to generate a
     repository out of a set of files.

_U_s_a_g_e:

     genRepos(repName, urlBase, urlPath, repType=c("package","vignette"),
              repRelLevel=c("release","devel"), dir = ".", HTML=TRUE, functionDesc=FALSE)

_A_r_g_u_m_e_n_t_s:

 repName: The name of the repository

 urlBase: A base URL for the repository (e.g.
          http://www.bioconductor.org/)

 urlPath: A path from the urlBase (e.g. packages/download/)

 repType: The type of repository, either package or vignette. Defaults
          to package

repRelLevel: The default release level for packages in this repository.
           Packages that don't have a 'ReleaseLevel' field in their
          'DESCRIPTION' file will be of this release level.  The
          default is 'release'.

     dir: The directory to create the repository in

    HTML: For package repositories, toggles HTML generation

functionDesc: Whether or not to create an HTMLized version of Rdindex.

_D_e_t_a_i_l_s:

     For more detailed information, the user is directed to the
     vignette file "HOWTO set up a simple R repository" in the
     'reposTools' package.  To do this, you can use the 'vignette'
     command in the 'annotate' package: vignette("HOWTO set up a simple
     R repository", package="reposTools").  

     genRepos is passed basic information about the repository as well
     as indicators as to what should be autogenerated or manually
     inputed, and will create two files:  One file 'replisting', which
     contains a matrix of repository information and the other
     'repdatadesc.rda' which contains a data.frame representing the
     files to be distributed.  These two special files are accessed by
     client functions.

     HTM generation uses the 'genReposHTML' function.

_V_a_l_u_e:

     genRepos returns a list containing basic information about the
     repository generated.

_A_u_t_h_o_r(_s):

     Jeff Gentry

_S_e_e _A_l_s_o:

     'install.packages2','ReposEntry', 'genReposHTML'

_E_x_a_m_p_l_e_s: