Devtools::document Index Page

Package development
1

Hi all,

@hadley says that one can include a .R file in your package to have a help page for the entire package (R Packages (2e) - 16  Function documentation).

But, if I include the code provided there or follow the approach dplyr takes (https://github.com/tidyverse/dplyr/blob/master/R/dplyr.r + dplyr/DESCRIPTION at main · tidyverse/dplyr · GitHub), I end up with two pages in the 00index.html of my package documentation. One is called like the package, the other is package-package:

Capture1

What should happen (at least if I look at the dplyr 00index.html) is that I have a single .Rd that is separated from the package functions at the top of my index :

Capture

I could not come up with a minimal reproducible example - if it helps the code for the package is on:

Cheers
Marco

2

Know that in dplyr index page, you also have two files. In section for letter D you will also find the dplyr package help page.
image

the only difference is that you don't have the letters links in the index, probably because you do not have a lot of functions... but that is to be confirmed.

3

This is correct behaviour — every alias appears in the index. We need two aliases here so that both (eg) ?dplyr and package?dplyr work.

1 Like