generateRoxygenComment: Generate roxygen2 documentation from data check object
Description
`generateRoxygenComment()` is a function for generating roxygen2 comments for
a given data check. It's not super flexible as it just inserts metadata into
a hard coded skeleton.
Usage
generateRoxygenComment(DC)
Arguments
DC
Data check to generate documentation for.
Value
Data check description in a roxygen2 comment style