Exercise

Additional documentation

Beyond the functions arguments and return values there are many additional items that can be provided in function help files. From who wrote that function to other functions that you might be interested in using. We will also see later how we can identify dependencies using the roxygen header.

Other tags that we can use include:

@author to identify who wrote the function.
@seealso to list other functions that may be of interest to users.
@notes to add any other notes relating to the function (e.g. if its experimental, likely to change etc.)

Instructions

100 XP

Add in the author of the data_summary() function as "My Name <[email protected]>".
List the summary() function (from the base package) after adding the author.