Get startedGet started for free

Generate help file documentation

After creating your documentation using roxygen2 headers, the next step is to build it. You can achieve this for all functions in the package by utilizing the roxygenize() function from the roxygen2 package. The documentation for each function will be generated as separate files (one for each function) in the man directory. Once this documentation creation step is complete, you can access the help files and view them alongside your other packages. By following this process, you ensure that your package is well-documented and ready for use.

The roxygen2 package has been loaded for you in addition to all of the package files up to this point in the course.

This exercise is part of the course

Developing R Packages

View Course

Exercise instructions

  • Generate documentation for all functions in the unitConverter package.

Hands-on interactive exercise

Have a go at this exercise by completing this sample code.

# Generate all function documentation
___
Edit and Run Code