1. Learn
    2. /
  2. Courses
    3. /
  3. Creating R Packages

Exercise

Undocumented parameters

If you've forgotten to document any of the parameters, when you run the check() function, you'll get a WARNING message that looks a bit like this:

Undocumented arguments in documentation object 'numeric_summary'
  'na.rm'

Note: you wouldn't normally get this error for non-exported functions

To remove this warning, you'll need to update the documentation for the parameter in the function's .R file, and then run check() again. You might think you need to run the document() function again. However, there's no need to do this, as check() automatically runs document() for you before completing its checks.

Instructions

100 XP
  • Update the roxygen header for the function "numeric_summary" to document the missing parameter (na.rm).
  • Include the following description for the parameter "a logical value indicating whether NA values should be stripped before the computation proceeds."