Skip to content
This repository has been archived by the owner on May 19, 2021. It is now read-only.

A single interface to navigate the documentation of multiple packages #58

Open
maurolepore opened this issue May 15, 2018 · 3 comments
Open

Comments

@maurolepore
Copy link
Member

(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 maurolepore changed the title Table all functions and datasets by package for multiple packages in a GitHub organization A single interface to navigate the documentation of multiple packages May 18, 2018
@maurolepore
Copy link
Member Author

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.

@mpadge
Copy link
Member

mpadge commented May 18, 2018

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.

@maurolepore
Copy link
Member Author

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants