Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation links not working #2

Closed
bpbond opened this issue Dec 7, 2016 · 2 comments
Closed

Documentation links not working #2

bpbond opened this issue Dec 7, 2016 · 2 comments

Comments

@bpbond
Copy link
Member

bpbond commented Dec 7, 2016

A number of documentation links don't work, i.e. devtools::check() is reporting errors on them. I'm about to open a PR that changes them (for now) to just \code{}, i.e. removes the links, because I want to make sure the package passes R CMD CHECK for #1 . They include

  • \code{\link{mapproj::coord_map}} in diag_header:43
  • \code{\link{map.usa}} in gcammaptools:36
  • \code{\link{ggalt::coord_proj}} and in Map_Functions:49
  • \code{\link{mapproj::coord_map}} in Map_Functions:440
@rplzzz
Copy link
Contributor

rplzzz commented Dec 8, 2016

That's not too surprising, since map.usa doesn't exist yet. I need to dig up the shapefile for GCAM-USA somewhere. For the others, it appears that you can't link to the documentation for a function in another package (or if you can do it, the way I tried to do it isn't the right way).

@rplzzz
Copy link
Contributor

rplzzz commented Jan 13, 2017

BTW, I figured out how to link to documentation in other packages. You write \link[package]{function}. When I get a chance I'll go back and fix the broken links identified here.

@rplzzz rplzzz closed this as completed in f3419c2 May 26, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants