genReposControlFiles: Generate CRAN-style repository control files

View source: R/repository.R

genReposControlFilesR Documentation

Generate CRAN-style repository control files

Description

This function generates control files for CRAN-style repositories. For each path specified in contribPaths a PACKAGES file is written. In addition, two top-level control files are created:

REPOSITORY contains information about the specified contrib paths.

VIEWS contains metadata for all packages in the repository including the paths to any extracted vignettes, if found. This file is useful for generating HTML views of the repository.

Usage

genReposControlFiles(reposRoot, contribPaths, manifestFile = NA,
  meatPath = NA)

Arguments

reposRoot

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

contribPaths

A named character vector. Valid names are source, win.binary, mac.binary, mac.binary.mavericks, and mac.binary.el-capitan. Values indicate the paths to the package archives relative to the reposRoot.

manifestFile

character(1). File path location to Bioconductor formatted manifest file that lists all current packages. This file will be used in the write_VIEWS function to cross check successfully built packages with all expected packages. Packages that have not built will be given dummy entry for complete listing in bioc_VIEWS. If NA cross check is skipped and packages not built on any system will be missing from biocVIEWS

meatPath

character(1). File path location to the directory containing cloned repositories of Bioconductor packages. If manifestFile is used for cross checking and the meatPath is provided, entries from the DESCRIPTION file are manually entered into biocVIEWS information. If NA dummy values for minimal fields for landing page generation are included with ERROR. This attempts to fill in as much information as possible for packages that have failed to build.

Author(s)

Seth Falcon

See Also

write_PACKAGES, extractVignettes, write_REPOSITORY, write_VIEWS


Bioconductor/biocViews documentation built on Nov. 2, 2024, 7:23 a.m.