roxy_tag: Parsing tags.

Description Usage Arguments Details

View source: R/tag.R

Description

roxy_tag constructs a tag object, and roxy_tag_warning makes an informative warning using the location information stored in the tag. The remainder of the tag functions parse the tag value, convert a string into a richer R object, or providing informative warnings and returning valid if the value is invalid.

Usage

 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

Arguments

tag

Tag name

val

Tag value. When read from the file, this will be a string, but after parsing can be a more complicated structure (typically a character vector, but sometimes a list).

file, line

Location of the tag

first, second

Name of first and second parts of two part tags

required

Is the second part required (TRUE) or can it be blank (FALSE)?

min, max

Minimum and maximum number of words

Details

Two exceptions to the rule are tag_words and tag_two_part, which are tag parsing generator functions.


roxygen2 documentation built on Nov. 7, 2018, 9:05 a.m.