convert_match_format {roxytypes}R Documentation

Match a conversion format and structure results

Description

Match a conversion format and structure results

Usage

convert_match_format(x, format)

Arguments

x

(character[1]) Content to match.

format

(character[1]) A regular expression, optionally containing named capture groups for type and description, which will be used for restructuring the tag as a roxytypes-equivalent tag.

Value

(⁠: list⁠) A named list of type, description and matched fields. type and description represent the result of captured groups. If no capture groups were used, the raw string is used as a description. matched is a logical[1] indicating whether the provided format matched against the provided input.

See Also

Other convert: build_convert_edits(), convert_tag(), make_convert_edits(), tag_edit()


[Package roxytypes version 0.1.1 Index]