link to packages on github in function documentation

Adding

\link[package]{function}

creates a link in function documentation linking to another package. But this only seems to work for CRAN packages. If there a similar way to link to a package that resides on GitHub?

It creates a link to any installed package with the given name.

Ah, my bad. I didnt explain properly.
Yes locally that is right.

But when the the function documentation is part of pkgdown documentation hosted on GitHub the link breaks.

sorry for not being clear

Maybe the pkgdown autolinking vignette can help?

Thanks @maelle,

So i didn't have the pkgdown URL specified in BOTH the DESCRIPTION file and the _pkgdowm.yml.

All seems good now. Thanks a lot

1 Like