Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Improve R documentation integration

See original GitHub issue

First of all thanks a big thanks to all the contributors of this project. I recently started using vscode-R and it starting to be a very solid alternative to Rstudio, it is also good to see the project getting new features every week 👍.

I would like to submit a couple suggestions to improve the user experience with the R documentation:

Add a command r.help to vscode-R in the spirit of r.head so that the selected function name in the editor can be sent to the console with r help(<selected_text>), this would allow users to map shortcuts to it and quickly jump to the help page.
Add the possibility to copy text from the R documentation in the html viewer in order to be able to paste it into the console or the text editor (e.g. I often do this with examples, function names, argument names, etc.).
Add a search bar in the html documentation viewer.
Add a black theme option to the html viewer possibly linked to the editor background color (#178).

Thanks

Issue Analytics

State:
Created 4 years ago
Reactions:4
Comments:5 (2 by maintainers)

Top GitHub Comments

2reactions

renkun-kencommented, Jan 27, 2020

Thanks for your suggestions!

Add a command r.help to vscode-R in the spirit of r.head so that the selected function name in the editor can be sent to the console with r help(<selected_text>), this would allow users to map shortcuts to it and quickly jump to the help page.

This looks like a special case of #201.

Add the possibility to copy text from the R documentation in the html viewer in order to be able to paste it into the console or the text editor (e.g. I often do this with examples, function names, argument names, etc.).

This is currently limited by the user operations allowed by WebView. See https://github.com/microsoft/vscode/issues/65452.

Add a search bar in the html documentation viewer.

I’m not sure if it is possible to do this because the R documentation is purely provided by a http server started from R. The WebView just shows the URL triggerred by browser. It does nothing else and it even cannot know it is help documentation.

Add a black theme option to the html viewer possibly linked to the editor background color (#178).

I’m trying to figure out but I don’t know a robust way to do this at the moment.

0reactions

renkun-kencommented, Jun 27, 2021

Closing as the help pages are supported now.

Top Results From Across the Web

Writing R Extensions - The Comprehensive R Archive Network

This is a guide to extending R, describing the process of creating R add-on packages, writing R documentation, R's system and foreign language...

3.4 Documentation | Mastering Software Development in R

3.4 Documentation. The objectives of this section are: Create R function documentation using roxygen2; Create vignettes using knitr and R Markdown.

R package to integrate rdocumentation.org into your R workflow

Search through all CRAN, Bioconductor, Github packages and their archives thanks to RDocumentation. Browse beautifully formatted and designed help pages. Post ...

R Packages (2e) - 17 Function documentation

Base R provides a standard way of documenting a package where each function is documented in a topic, an .Rd file (“R documentation”)...

Improving automatic document production with R - Locke Data

In this post, I describe the latest iteration of my automatic document production with R. It improves upon the methods used in Rtraining, ......