16.8 Object documentation defined

  • Focus for tonight is on object documentation
    • What do you think when you hear the word object?
    • Accessed via ? or help()
  • Object documentation: reference documentation.
    • Purpose is to serve as a reference (e.g., a dictionary entry)
    • Great use case for standardized naming conventions (e.g., stringr package)
  • Difference between object documentation and vignettes
    • Object documentation = A short-form reference guide
    • Vignettes = A long-form document on how to use package objects to solve a problem