writeRepositoryHtml: Write package descriptions and a repository index as HTML

Description Usage Arguments Author(s)

View source: R/repository.R

Description

This function generates an HTML file for each package in a repository and generates an index.html file that provides an alphabetized listing of the packages.

Usage

1
2
3
4
writeRepositoryHtml(reposRoot, title, reposUrl = "..", viewUrl = "../..",
                    reposFullUrl=reposUrl, downloadStatsUrl="",
                    devHistoryUrl="", link.rel = TRUE,
                    backgroundColor="transparent")

Arguments

reposRoot

string specifying the path to the root of the CRAN-style package repository.

title

string giving the title for the repository

reposUrl

string giving the prefix for URL in links generated on the package description pages. The default is "..." which works well if the package description HTML files are written to an html subdirectory under the root of the repository.

viewUrl

string giving the prefix for the URL in links to the view pages. The biocViews terms will be linked to views summary pages with this prefix.

reposFullUrl

string giving the full prefix for URL in links generated on the package description pages. The default is reposUrl.

downloadStatsUrl

string giving the prefix for the URL in links to the download history statistics pages.

devHistoryUrl

string giving the prefix for the URL in links to the development changelog.

link.rel

logical indicating whether the index page should generate relative URL links. The default is TRUE. If you are generating HTML for a remote repository, you will want to set this to FALSE.

backgroundColor

A character vector giving the background color for the body in the CSS file.

Author(s)

Seth Falcon


Bioconductor-mirror/biocViews documentation built on June 1, 2017, 5:19 a.m.