ctv-server {ctv}R Documentation

CRAN Task Views: Server-side Tools

Description

Server-side tools for maintaining CRAN task views.

Usage

repos_update_views(repos = ".", css = "../CRAN_web.css", reposname = "CRAN", ...)

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

Arguments

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.

Details

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.

Value

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 elements:

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.
email character, valid e-mail address (optional).
version character, version specified via date in ISO format.
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.

See Also

install.views

Examples

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

[Package ctv version 0.5-1 Index]