Bioconductor / BiocStyle

Issues and pull requests for BiocStyle should go here.
12 stars 20 forks source link

Convenience function to link between workflows #46

Closed LTLA closed 6 years ago

LTLA commented 6 years ago

It would be nice if we had way to easily add references to other Bioconductor workflows, other than copying-and-pasting the URL. The idea would be to have something similar to the Biocpkg() function, but for workflows. For example, I would like to be able to write something like

Biocworkflow("simpleSingleCell/part1")

... and this would return a link to https://bioconductor.org/help/workflows/simpleSingleCell/part1/. One could extend this to reference specific sections or even figures (though I'm not sure how feasible the latter is).

The motivation is to centralize the linking decisions into BiocStyle, which will provide some robustness to changes to how the Bioconductor website is organized. Indeed, now that we're getting release and devel versions of the workflows, one could imagine that a Biocworkflow() function would automatically link to the correct version, depending on the environment in which the workflow was being built.

BTW, this originates from a half-forgotten discussion at Euro-BioC-2017.

LTLA commented 6 years ago

Just nudging this; I think a feature like this would be really useful, now that there's about 6 different documents in simpleSingleCell alone, for example, and it would be nice to cross-link them more formally.

LTLA commented 6 years ago

This was resolved by #51, so I'm closing it.