Session Ready
Exercise

A simple function header

The roxygen headers are included in the same script as the function code. You use roxygen comments #' to identify a line as part of the roxygen header. You can include regular R comments in the header if you wish, using the usual comment character, #.

The first three lines of the header have special meaning and you don't need to use tags to identify them. The first three lines are:

  • title
  • description
  • details

Since you don't mention any tags to identify the first three lines, it is necessary that you seperate each one of them by a new line. For example: 

#' Title goes here
#'
#' Description goes here
#'
#' Details go here
Instructions
100 XP
  • Add the title "Numeric Summaries" to your header.
  • Add the following short description of the function: "Summarises numeric data and returns a data frame containing the minimum value, median, standard deviation, and maximum value."