Excluding topics in pkg_manual()

[TimTaylor]

Is it worth having some form of filter parameter within pkg_manual() to allow some help topics not to be rendered?

My particular motivation here is deprecated functions where I'm 50/50 as to whether I want them to show on the site or not.

[TimTaylor]

Actually, perhaps just excluding those marked with internal keyword would be best/easiest. This would be consistent with how R's help uses the internal keyword (https://cran.r-project.org/doc/manuals/r-devel/R-exts.html#index-_005ckeyword) to exclude things from the list of help topics.

See also: https://github.com/wch/r-source/blob/dd13e3fba916bf3eb11842f0e7b5b2535f6e6d1d/src/library/utils/R/help.search.R#L620-L633

[yihui]

Done: b951034

[TimTaylor]

Small usethis user issue that you may want to be aware off. The package doc template that usethis::use_package_doc() creates and roxygen converts in to xxx-package.Rd, uses the internal keyword. In this circumstance the overview argument will then not do anything. Like I say, a user issue, but flagging for awareness.

[yihui]

Thanks for the note! I'll make overview = TRUE override the keyword internal, i.e., overview = TRUE means xxx-package.Rd is always included, even if it has the internal keyword.

[TimTaylor]

There's another small issue with b951034. At the moment the exclusion of internal pages is only being applied to the resulting content. It needs to happen before the the aliases (al) are calculated. Currently it still generates the internal alias links at the top of the page.

Hope this makes sense.

[yihui]

Good catch. I'll filter the pages earlier. Thanks!