convert {roxytypes} | R Documentation |
Convert roxygen2
tags to roxytypes
tags
Description
Convert a package codebase into applicable roxytypes
tags. For roxygen2
tags with drop-in replacements (namely @param
and @return
tags), process
descriptions and replace tags with roxytypes
equivalents.
Usage
convert(
path = ".",
format = config(path, refresh = TRUE, cache = FALSE)$format,
...,
unmatched = FALSE,
verbose = interactive()
)
Arguments
path |
( |
format |
( |
... |
Additional arguments passed to |
unmatched |
( |
verbose |
( |
Details
A format string is built using build_format_regex()
, which accepts
parameters type
and description
, which describe how to match these
components of a parameter definition. They are combined with the literal
content of format
to produce a regular expression to split existing
definitions.
For comprehensive control, pass format_re
directly, bypassing expression
construction altogether.
Value
(logical[1]
) TRUE
if successfully completes, FALSE
if aborted. Always returns
invisibly.
Examples
## Not run:
convert("(`{type}`) {description}")
## End(Not run)