Run a test on function examples
It is best practice to include examples for users of your package and its functions in the help documentation. This allows you to validate the behavior and correctness of the function against a set of predefined examples or test cases.
The following examples have been added to the roxygen2
heading for dist_converter()
:
#' @examples
#' # Meters to feet
#' dist_converter(4, "meters", "feet")
#' # Feet to meters
#' dist_converter(10.5, "feet", "meters")
#' \dontrun{
#' # Feet to feet (gives warning)
#' dist_converter(100, "feet", "feet")
#' # Non-numeric `dist_value` gives error
#' dist_converter("short", "feet", "meters")
#' }
The testthat
package and the unitConverter
package at this point in development have been loaded for you.
This exercise is part of the course
Developing R Packages
Exercise instructions
- Run a test on the function examples given with the
dist_converter()
function.
Hands-on interactive exercise
Have a go at this exercise by completing this sample code.
# Test dist_converter() examples
___