17.5 Links

There is no official way to link to help topics from vignettes or vice versa or from one vignette to another.

• This is a concrete example of why we think pkgdown sites are a great way to present package documentation, because pkgdown makes it easy (literally zero effort, in many cases) to get these hyperlinked cross-references. This is documented in vignette(“linking”, package = “pkgdown”).

Here are the two most important examples of automatically linked text:

• some_function(): Autolinked to the documentation of some_function(), within the pkgdown site of its host package. Note the use of backticks and the trailing parentheses.

• vignette("fascinating-topic"): Autolinked to the “fascinating-topic” article within the pkgdown site of its host package. Note the use of backticks.