parse_package {roxygen2} | R Documentation |
parse_package()
, parse_file()
, and parse_text()
allow you to use
roxygen's parsing code to parse the roxygen blocks from a package, file, or
character vector of code. env_package()
and env_file()
provide
defaults that generate a temporary environment making it possible to
associate each block with the corresponding live object.
parse_package(path = ".", env = env_package(path), registry = default_tags(), global_options = list()) parse_file(file, env = env_file(file), registry = default_tags(), global_options = list()) parse_text(text, env = env_file(file), registry = default_tags(), global_options = list()) env_file(file) env_package(path)
path, file, text |
Either specify a |
env |
An environment environment containing the result of evaluating the input code. The defaults will do this for you in a test environment: for real code you'll need to generate the environment yourself. You can also set to |
registry |
A roclet tag registry: this is a named list where the
name gives the tag and the value gives the parsing code. See the
|
global_options |
A list of global options:
|
A list of roxy_block objects