build_convert_edits {roxytypes}R Documentation

Build a collection of conversion edits

Description

Build a collection of conversion edits

Usage

build_convert_edits(format, tags, unmatched = FALSE)

Arguments

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.

tags

(list(roxy_tag)) A collection of roxygen2::roxy_tag() objects to edit. Can include tags which have no plausible conversion, which will be filtered before returning edits.

unmatched

(logical[1]) Whether to make edits to existing tags which can not be matched with the provided format. If TRUE, the existing description is migrated verbatim to the new tag, without a type provided. The new syntax will produce warnings when running roxygen2::roxygenize(), which can be useful tool for pinpointing tags that need manual fine-tuning for conversion.

Value

(data.frame) A collection of possible tag edits as produced by tag_edit().

See Also

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


[Package roxytypes version 0.1.2 Index]