ctv-server {ctv} | R Documentation |
CRAN Task Views: Tools for Maintainers
Description
Server-side tools for maintaining CRAN task views.
Usage
read.ctv(file, ...)
ctv2html(x, file = NULL, cran = FALSE,
css = NULL, packageURL = NULL, reposname = "CRAN")
check_ctv_packages(file, repos = TRUE, ...)
repos_update_views(repos = ".", cran = TRUE,
css = NULL, reposname = "CRAN", ...)
Arguments
file |
character specifying a file path: for |
x |
an object of class |
cran |
logical. Is the HTML to be hosted on CRAN? |
css |
character specifying the path and name of the cascade style
sheet that should be included in the HTML files (if any). The default
is |
packageURL |
character specifying the path (relative to the view directory)
to the package descriptions. The default is |
reposname |
character giving the name of the CRAN-style repository, used for generating HTML pages. |
repos |
character, the base URL of the CRAN-style repository where the ‘Views.rds’
and ‘.html’ files should be installed. The task view files should
be located in the ‘web/views/’ directory. If |
... |
further arguments passed to |
Details
CRAN Task views are generated from an R/Markdown-based file format that is described in the vignette of this package. (Previous versions used an XML-based format which is still fully supported in all functions.)
read.ctv
can read a file with a CRAN task view specification
and returns an object of class "ctv"
. This functions requires the availability
of the knitr/rmarkdown packages (or the xml2 package, respectively,
for the legacy XML format).
ctv2html
generates a ‘.html’ file with the information contained in
a "ctv"
object.
check_ctv_packages
checks whether the info and packagelist sections of the
task view file are consistent with each other and whether all packages are available
from the repository.
repos_update_views
reads all task view 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
repos_update_views
returns an object of class "ctvlist"
containing
the "ctv"
objects available.
ctv2html
returns invisibly a vector with the HTML code generated.
check_ctv_packages
returns a list of character vectors with package names.
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. |
url |
character, valid task view URL (optional). |
source |
character, source repository where the task view file is maintained (optional). |
info |
character, HTML code with informations about the task view. |
packagelist |
data frame with the columns |
links |
character vector, HTML code with links for the task view. |
otherlinks |
character vector, HTML code with links to other resources for the task view. |
citation |
citation object inheriting from |
See Also
Examples
## task view file shipped within the package
ctv <- system.file("ctv", "Econometrics.md", package = "ctv")
if(require("knitr") & require("rmarkdown")) {
## read task view file
x <- read.ctv(ctv)
## print
x
}
## Not run:
## generate corresponding .html file from task view object
ctv2html(x)
## or equivalently from task view file
ctv2html(ctv)
## check packagelist
check_ctv_packages(ctv)
## End(Not run)