roxy_block {roxygen2} | R Documentation |
Blocks
Description
A roxy_block
represents a single roxygen2 block.
The block_*
functions provide a few helpers for common operations:
-
block_has_tag(blocks, tags)
: doesblock
contain any of thesetags
? -
block_get_tags(block, tags)
: get all instances oftags
-
block_get_tag(block, tag)
: get single tag. ReturnsNULL
if 0, throws warning if more than 1. -
block_get_tag_value(block, tag)
: getsval
field from single tag.
Usage
roxy_block(tags, file, line, call, object = NULL)
block_has_tags(block, tags)
block_get_tags(block, tags)
block_get_tag(block, tag)
block_get_tag_value(block, tag)
Arguments
tags |
A list of roxy_tags. |
file , line |
Location of the |
call |
Expression associated with block. |
object |
Optionally, the object associated with the block, found
by inspecting/evaluating |
block |
A |
tag |
A single tag name. |
Examples
# The easiest way to see the structure of a roxy_block is to create one
# using parse_text:
text <- "
#' This is a title
#'
#' @param x,y A number
#' @export
f <- function(x, y) x + y
"
# parse_text() returns a list of blocks, so I extract the first
block <- parse_text(text)[[1]]
block
[Package roxygen2 version 7.2.3 Index]