ctv-server                package:ctv                R Documentation

_C_R_A_N _T_a_s_k _V_i_e_w_s: _S_e_r_v_e_r-_s_i_d_e _T_o_o_l_s

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

     Server-side tools for maintaining CRAN task views.

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

     updateViews(repos = ".", css = "../../../R.css", reposname = "CRAN", ...)

     read.ctv(file)
     ctv2html(x, file = NULL, css = "../../../R.css", packageURL = "../Descriptions/", reposname = "CRAN")

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

   repos: character, the base URL of the CRAN-style repository where
          the 'Views.rds' and '.html' files should be installed. The
          '.ctv' files should be located in the 'src/contrib/Views'
          directory.

     css: character specifying the path and name of the cascade style
          sheet that should be included in the HTML files.

reposname: character giving the name of the CRAN-style repository, used
          for generating HTML pages.

     ...: further arguments passed to 'ctv2html'.

    file: character specifying a CRAN task view '.ctv' file.

       x: an object of class '"ctv"' as returned by 'read.ctv'.

packageURL: character specifying the path (relative to the view
          directory) to the package descriptions.

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

     CRAN Task views are generated from an XML-based format '.ctv' that
     is described in the vignette of this package.

     'read.ctv' can read a '.ctv' file with a CRAN task view
     specification and returns an object of class '"ctv"'. This
     functions requires the availability of the 'XML' package.

     'ctv2html' generates a '.html' file with the information contained
     in a '"ctv"' object.

     'updateViews' reads all '.ctv' files in a specified directory,
     generates a '.html' file for each and an index '.html' file.
     Furthermore, it stores all '"ctv"' objects in a '"ctvlist"' object
     in a file 'Views.rds' that can be queried by 'install.views' or
     'CRAN.views'.

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

     'updateViews' returns an object of class '"ctvlist"' containing
     the '"ctv"' objects available.

     'ctv2html' returns invisibly a vector with the HTML code
     generated.

     'read.ctv' returns a list of class '"ctv"' with slots: 

    name: character, name of the task view (must be a valid name for an
          R object).

   topic: character, topic of the task view.

maintainer: character, maintainer of the task view.

    info: character, HTML code with informations about the task view.

packagelist: data frame with the columns 'name' (character, name of
          package) and 'core' (logical, Is priority core?).

   links: character vector, HTML code with links for the task view.

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

     'install.views'

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

     ## read .ctv file
     x <- read.ctv(file.path(.find.package("ctv"), "ctv", "Econometrics.ctv"))
     x

     ## Not run: 
     ## generate corresponding .html file
     ctv2html(x)
     ## End(Not run)

