Skip to content

Style Guide for Roxygen Headers

Ben Straub edited this page May 11, 2023 · 6 revisions

Title

@param Arguments for xportr_ functions

As the xportr_ functions follow a common design the @params should all be the same.

  • .df
  • metadata
  • domain
  • verbose

@examples for xportr_ functions

  • Showcase a simple working example
  • Showcase a simple working with a verbose = warn
  • Showcase a simple example with verbose = stop
Clone this wiki locally