How to `\link{}` to a specific section of an Rd file with Roxygen2?

Question

Say I want to link to the "Details" section of my documentation for function foo, what do I do? \link{foo:Details} doesn't appear to work, so what is the right command?

You could request this feature on r-devel http://www.r-project.org/mail.html, and see if any core members are sympathetic. — Richie Cotton, Feb 05 '14 at 14:14
Please have a look: https://stackoverflow.com/questions/20014218/r-roxygen-link-to-parent-function — Grzegorz Sapijaszko, Sep 25 '22 at 16:40

score 1 · Answer 1 · edited Oct 27 '22 at 14:36

1

You can use \linkSections{} to link to sections of an Rd file.

\linkSections{foo}

will link to the section of the foo documentation that you are currently viewing.

If you want to link to a specific section, you can use

\linkSections{foo,Details}

to link to the Details section of the foo documentation.

edited Oct 27 '22 at 14:36

OliverHennhoefer

677
2
8
21

answered Oct 20 '22 at 11:20

Spacewink

99
8

How to `\link{}` to a specific section of an Rd file with Roxygen2?

1 Answers1