viewRd: View Rd files in a source package

Description Usage Arguments Details Value Note Author(s)

View source: R/bib.R

Description

View Rd files in a source package.

Usage

1
viewRd(infile, type = "text", stages = NULL)

Arguments

infile

name of an Rd file, a character string.

type

one of "text" or "html"

stages

a character vector specifying which stages of the R installation process to immitate. The default, c("build", "install", "render"), should be fine in most cases.

Details

This function can be used to view Rd files from the source directory of a package. The page is presented in text format or in html browser, according to the setting of argument type. The default is text.

Value

the function is used for the side effect of showing the help page in a text help window or a web browser.

Note

Developers with "devtools" can use viewRd() instead of help() for documentation objects that contain Rd macros, such as insertRef, see vignette:

vignette("Inserting_bibtex_references", package = "Rdpack").

Author(s)

Georgi N. Boshnakov


Rdpack documentation built on Oct. 4, 2018, 5:05 p.m.