unconf18 icon indicating copy to clipboard operation
unconf18 copied to clipboard

A single interface to navigate the documentation of multiple packages

Open maurolepore opened this issue 7 years ago • 3 comments

(Relates to #48, #25.)

How can you search all funcions, datasets and help files across multiple packages within a GitHub organization (e.g. tidyverse, rOpenSci)?

You may use https://www.rdocumentation.org/ or the search field of a GitHub organization; but I think those tools are too general. I propose to build a small package to create a searchable and clickable table of all functions or datasets by package -- including any number of packages within a GitHub organization. A good place to host such a table is on the website of the relevant GitHub organization.

Here is an example, which I built to solve my problem at the time. We could make the code more general and package it up.

maurolepore avatar May 15 '18 01:05 maurolepore

Summary: Build a small package to create a searchable and clickable table of all functions or datasets by package -- including any number of packages within a GitHub organization.

maurolepore avatar May 18 '18 05:05 maurolepore

Cross link to #25, which is a call for effectively the same thing. The flipper package has a lot of the necessary infrastructure for this.

mpadge avatar May 18 '18 06:05 mpadge

Summary: This issue seems to be largely nested in #25. @mpadge, maybe we should discuss the overlap in person? Feel free to close.

maurolepore avatar May 19 '18 02:05 maurolepore