16.9 Object documentation, an overview

  • Documentation files are rendered from a syntax loosely based on LaTex.
  • roxygen2 provides a more user-friendly syntax to create documentation
    • Comments using @tags >> man/.Rd files >> HTML or PDFs
    • Code is intermingled with documentation
    • Handles some boilerplate set up
    • Abstracts away the differences for documenting different objects
    • Manages the NAMESPACE (Chapter 13)