roxygen_comment_generate: Generate roxygen2 documentation from data check object

Description Usage Arguments Value

View source: R/class_export.R

Description

'roxygen_comment_generate()' 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

1

Arguments

DC

Data check to generate documentation for.

Value

Data check description in a roxygen2 comment style


bd-R/bdchecks documentation built on Oct. 8, 2021, 5:10 p.m.