https://github.com/flowr-analysis/vscode-dev-flowr-sample

https://github.com/flowr-analysis/vscode-dev-flowr-sample

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/flowr-analysis/vscode-dev-flowr-sample
• Owner: flowr-analysis
• License: cc0-1.0
• Created: 2025-02-17T14:05:08.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-02-17T16:24:10.000Z (4 months ago)
• Last Synced: 2025-03-15T13:59:22.982Z (4 months ago)
• Language: R
• Homepage: https://vscode.dev/github/flowr-analysis/vscode-dev-flowr-sample
• Size: 7.86 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# *flowR* VS Code Sample

This is a sample repository that you can use to try out the *flowR* extension for Visual Studio Code right in your browser using [VS Code.dev](https://vscode.dev/), or using VS Code locally.






[![](https://img.shields.io/badge/Open_in_VS_Code.dev-a32638?style=flat&logo=github)](https://vscode.dev/github/flowr-analysis/vscode-dev-flowr-sample)






## How to Use

To set up your own *flowR* workspace, simply click the button above. When you open one of the R files provided as part of the sample, the site will ask you to install the *flowR* extension through a popup in the bottom-right corner. Select it and accept the approval popup to install the *flowR* extension. Once the extension is installed, you can get started using *flowR*!

Alternatively, you can also clone this repository locally and open it with VS Code. Similarly to VS Code.dev, you will be prompted to install the *flowR* extension locally. Follow the same steps and you're ready to go!

## Things to Try

You can generate a [slice](https://github.com/flowr-analysis/flowr/wiki/Terminology#program-slice) of the currently highlighted variable in any of the sample code by using the **Slice for Cursor Position** command. All code that is not part of the generated slice will then be grayed out.

You can also view the reconstruction of a piece of code based on the current slice. The **Show Current Slice in Editor (Reconstruct)** command opens a view next to the current editor.

The extension has a lot more features to try! For a more extensive list, check out [the extension's README](https://github.com/flowr-analysis/vscode-flowr?tab=readme-ov-file#use).

### Example Use-Cases

This sample contains some randomly selected R files under [`./sample-files`](./sample-files/) you can use to play around - or use your own R files!

We have only modified these files to contain a meta-informational comment at the top, pointing to the full record.

1. Reviewing and comprehending existing R scripts

2. Reusing a figure or data cleaning step of a publication

3. Supporting maintenance and reproducibility

4. Interactively understand the impact of parts while developing the script