roxy_obj: Get roxygen2 block object
In salim-b/pal: Friendly Convenience/Utility Functions
roxy_obj R Documentation
Get roxygen2 block object
Description
Extracts a single object from a list of roxy_block objects.
Usage
roxy_obj(blocks, obj_name)
Arguments
blocks
A list of roxy_block objects as returned by roxy_blocks().
obj_name
Object name to extract, usually a function name. A character scalar.
Value
A roxy_block object.
See Also
Other package documentation functions:
enum_fn_param_defaults(),
fn_param_defaults(),
roxy_blocks(),
roxy_tag_value(),
roxy_to_md_links()
salim-b/pal documentation built on Feb. 28, 2025, 6:51 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| roxy_obj | R Documentation |
Get roxygen2 block object
Description
Extracts a single object from a list of roxy_block objects.
Usage
roxy_obj(blocks, obj_name)
Arguments
blocks |
A list of |
obj_name |
Object name to extract, usually a function name. A character scalar. |
Value
A roxy_block object.
See Also
Other package documentation functions:
enum_fn_param_defaults(),
fn_param_defaults(),
roxy_blocks(),
roxy_tag_value(),
roxy_to_md_links()
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.