help_at: Get help for a function at a package version

Description Usage Arguments Value See Also Examples

View source: R/interface.R

Description

Get help for a function at a package version

Usage

1
2
help_at(fun, version = version_at_date(package, date), package, date = NULL,
  quiet = TRUE, ...)

Arguments

fun

Function name as a character string. fun can be an S3 method; S4 methods aren't yet supported.

version

Version as a character string. If omitted, use the version available at date.

package

Package. Alternatively, specify the function name as e.g. "package::function".

date

Date, as a character string that can be read by as.Date() e.g. "2016-01-01".

quiet

Logical. Try to minimize output from package installation. (Some output comes from R CMD INSTALL and may be unavoidable.)

...

Arguments passed to versions::install.versions() or remotes::install_version(), and thence to install.packages(). Ncpus may be useful.

Value

The help object (text format only).

See Also

help()

Examples

1
2
3
4
5
## Not run: 
help_at("clipr::write_clip", "0.1.1")
help_at("clipr::write_clip", "0.2.0")

## End(Not run)

hughjonesd/apicheck documentation built on July 17, 2018, 7:21 a.m.