roxygenize_with_cache: Roxygen depending on cache state

View source: R/roxygen2.R

roxygenize_with_cacheR Documentation

Roxygen depending on cache state

Description

This function is only exported for use in hook scripts, but it's not intended to be called by the end-user directly.

Usage

roxygenize_with_cache(key, dirs)

Arguments

key

An optional object from which a hexadecimal hash code will be generated and appended to the filename.

dirs

A character vector constituting the path to the cache subdirectory (of the cache root directory as returned by getCacheRootPath()) to be used. If NULL, the path will be the cache root path.

See Also

Other hook script helpers: diff_requires_run_roxygenize(), dirs_R.cache(), may_require_permanent_cache(), robust_purl(), roxygen_assert_additional_dependencies()


precommit documentation built on July 2, 2022, 1:06 a.m.