biocViews (version 1.36.2)

write_VIEWS: Write a VIEWS control file for a CRAN-style package repository

Description

This function writes a VIEWS file to the top-level of a CRAN-style package repository. The VIEWS file is in DCF format and describes all packages found in the repository.

The VIEWS file contains the complete DESCRIPTION file for each source package in the repository. In addition, metadata for available binary packages and vignettes is centralized here.

Usage

write_VIEWS(reposRootPath, fields = NULL, type = c("source", "win.binary", "win64.binary", "mac.binary", "mac.binary.leopard","mac.binary.mavericks"), verbose = FALSE, vignette.dir = "vignettes")

Arguments

reposRootPath

character vector containing the path to the CRAN-style repository root directory.

fields

Any additional fields to include. You shouldn't need this, but if you have added fields to the DESCRIPTION files of the packages in the repository, you may want it.

type

One of source, win.binary, win64.binary, mac.binary, or mac.binary.leopard indicating which set of packages should be used to build up the "shared" information. Since a repository can contain different versions of the same package (source vs binary) the shared information may not be reliable.

verbose

logical, if TRUE, print progress messages.

vignette.dir

character specifying where to look for vignettes.

Warning

This function uses a private function from the tools package: tools:::.build_repository_package_db.

See Also

write_PACKAGES, extractVignettes, genReposControlFiles, write_REPOSITORY