19.8 Functions Reference Index

  • the reference/ contains a page for each function that has a .Rd help topic in man/
  • pkgdown will execute and render all of your examples
    • This is a good opportunity to make sure they look the way they are supposed to
  • The help topics will be linked to locations within/outside of your site
    • hark back to chapter 17 and recall enclosing functions in [] when mentioned in roxygen comments
    • pkgdown will automatically hyperlink to the relevant pages for your function.
    • Inbound links from other people’s packages require extra work:
      • Published to CRAN
      • the URL field in the DESCRIPTION file must be populated with the URL of your pkgdown site and GitHub repo
      • your _pkgdown.yml file must include the URL for your site.
    • devtools generally does this configuration for you