-
-
Notifications
You must be signed in to change notification settings - Fork 50
/
Copy pathroxygenize_with_cache.Rd
32 lines (31 loc) · 1.1 KB
/
roxygenize_with_cache.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/roxygen2.R
\name{roxygenize_with_cache}
\alias{roxygenize_with_cache}
\title{Roxygen and add a cache entry}
\usage{
roxygenize_with_cache(key, dirs)
}
\arguments{
\item{key}{An optional object from which a hexadecimal hash
code will be generated and appended to the filename.}
\item{dirs}{A \code{\link[base]{character}} \code{\link[base]{vector}} constituting the path to the
cache subdirectory (of the \emph{cache root directory}
as returned by \code{\link[R.cache]{getCacheRootPath}}()) to be used.
If \code{\link[base]{NULL}}, the path will be the cache root path.}
}
\description{
This function is only exported for use in hook scripts, but it's not intended
to be called by the end-user directly.
}
\seealso{
Other hook script helpers:
\code{\link{diff_requires_run_roxygenize}()},
\code{\link{dirs_R.cache}()},
\code{\link{may_require_permanent_cache}()},
\code{\link{precommit_docopt}()},
\code{\link{robust_purl}()},
\code{\link{roxygen_assert_additional_dependencies}()}
}
\concept{hook script helpers}
\keyword{internal}