extractVignettes: Extract pdf vignettes from local package repository

In Bioconductor/biocViews: Categorized views of R package repositories

Extract pdf vignettes from local package repository

Description

These functions extract pdf or HTML files from the inst/doc subdirectory of R source packages archives (.tar.gz) found in a local package repository.

All pdf files found in inst/doc will be extracted. With extractHTMLDocuments, all HTML files except index.html will be extracted. Only source package archives will be processed. The extracted pdf or HTML files will be extracted under destDir and will be found in PKGNAME/inst/doc/.

Prior to extraction, all pdf files in destDir/PKGNAME/inst/doc will be removed.

Usage

extractVignettes(reposRoot, srcContrib, destDir)
extractHTMLDocuments(reposRoot, srcContrib, destDir)

Arguments

reposRoot	character vector giving the path to the root of the local CRAN-style package repository
srcContrib	character vector giving the relative path from the reposRoot to the source packages. In a standard CRAN-style repository, this will be src/contrib.
destDir	character vector specifying the directory in which the extracted files will be written. If missing, files will be written to <reposRoot>/vignettes.

Author(s)

Seth Falcon

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