REditorSupport / REditorSupport/vscode-R

Feature Request: Implement Output Insertion as Comments for Evaluated R Code

Open
#1,457 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request
Dominant language
TypeScript
Stars
1.2k
Forks
139
Avg merge
2h 46m
Merged PRs (30d)
5

Description

Title: Feature Request: Implement Output Insertion as Comments for Evaluated R Code

Description:

I propose adding a feature to vscode-R that allows users to evaluate selected R code and automatically insert the output as comments in the editor. This feature, inspired by a similar functionality in Nvim-R, would enhance the data analysis workflow by allowing immediate inspection and documentation of code outputs within the editor.

Reference:

Key Points:

  • Select and evaluate R code in the editor.
  • Capture the output and insert it as a comment directly below the evaluated code.
  • Useful for iterative exploration and documentation in data analysis.

Implementation Suggestion:

  • Extend existing 'send code to terminal' functionality.
  • Add a method to capture terminal output and format it as a comment in the editor.

Impact:
This feature would streamline the R coding process in VS Code, making it more efficient for data analysis and similar tasks.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the existing “send code to terminal” functionality in the vscode-R extension and review the linked Nvim-R documentation and implementation for expected behavior. The feature is done when selected R code can be evaluated, its output captured, and that output inserted as comments directly below the code in the editor.

Written by the indexing model from the issue text.

Assessment

Tech stack
r, typescript, vscode
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.