Usethis: Link to obvious places in R Packages and WRE from help files

[jennybc]

[batpigandme]

💯 this! I actually started a sort of help/basics dictionary mapping to R4DS many moons ago (I must've been distracted by a shiny object, and never finished/successfully started), but I think this is a _really_ good idea!

Is there a way to treat chapters like man pages from other packages?

[jennybc]

Is there a way to treat chapters like man pages from other packages?

You mean with automatic linking behaviour or display within the help system? I think the answer is no on both fronts.

I've started to add with a @seealso tag if I'm there and it occurs to me. But that was very late in the game, in my recent pass through all the functions.

[jennybc]

I would welcome pull requests with very short @seealso entries adding links to R packages and Writing R Extensions (WRE).

Example from the docs for use_package_doc():

#' @seealso The [documentation chapter](http://r-pkgs.had.co.nz/man.html) of [R
#'   Packages](http://r-pkgs.had.co.nz)

[markdly]

I'm just getting set up with usethis as part of my usual workflow so I'm doing a bit of flitting back and forth between here and R packages. Perhaps this is something I can help with as a new user.

Looking through the code I thought the following functions could benefit from @seealso entries with links to sections of the R packages site:

|fn |suggested_url |
|:---------------|:----------------------------------------|
|use_data |http://r-pkgs.had.co.nz/data.html |
|use_description |http://r-pkgs.had.co.nz/description.html |
|use_license |http://r-pkgs.had.co.nz/description.html#license |
|use_namespace |http://r-pkgs.had.co.nz/namespace.html |
|use_news_md |http://r-pkgs.had.co.nz/release.html#important-files |
|use_r |http://r-pkgs.had.co.nz/r.html |
|use_readme_rmd |http://r-pkgs.had.co.nz/release.html#important-files |
|use_testthat |http://r-pkgs.had.co.nz/tests.html |
|use_vignette |http://r-pkgs.had.co.nz/vignettes.html |

Would a PR for these be welcome (at least as a start)?

[jennybc]

Yes @markdly I think having those links would be a clear improvement over not having them.

R Packages will go into revision for a 2nd edition at some point this year, which may have implications for links, but I still think it's good to establish these connections. A PR would be welcome.

[hadley]

Seems like we can close this issue now.