README.md vs package vignette vs ?package documentation

I love that idea. Especially as, at some point, you hit the: when all else fails, standardize; and I think that having a visual aid would go far. I ran into :star: Write the Docs (sub question to docs writers: any thoughts on this guide?), and there's a ~complementary of Read the Docs that includes some reflection on docs and teaching…

2 Likes

package?dplyr is probably what you were thinking of.

You can also use class?topic , methods?function and method?call(), but these generally only work for S4 classes and methods.

No, that takes you to the package help page, not the package help index, i.e.
http://127.0.0.1:17499/help/library/dplyr/html/dplyr-package.html instead of
http://127.0.0.1:17499/help/library/dplyr/html/00Index.html.

The more I look, the more I doubt my memory. I guess help(p = 'dplyr') isn't that many keystrokes anyway...