gadenbuie / shiny-vscode

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Shiny - VS Code Extension

This is an extension to help launch Shiny applications. Shiny is a package for Python and R that is designed to make it easy to build interactive web applications with the powerful data and scientific features of Python and R.

Features

The main features of this extension are additional options in the Run button menu when editing an app.py or app.R file to "Run Shiny App" or "Debug Shiny App" (Python only).

Run app

It also provides a couple of code snippets in both Python and R:

  • shinyapp for creating a new Shiny application
  • shinymod for creating a new Shiny module

For a complete Shiny for Python experience in VS Code, please visit our docs for more information, including instructions for configuring the type checker and debugger for use with Shiny.

Extension Settings

This extension contributes the following settings for Python and R.

Python

  • shiny.python.port: The port number to listen on when running a Shiny for Python app. (By default, 0, which will choose a random port for each workspace.)
  • shiny.python.debugJustMyCode: When running the "Debug Shiny App" command, only step through user-written code. Disable this to allow stepping through library code. (Defaults to true.)

Note that there is no setting for Python executable path or virtual environment. This extension uses whatever Python environment the VS Code Python extension thinks is active. If you find that the "Run Shiny App" and "Debug Shiny App" commands are launching with a different version of Python or different virtual environment than you intended, use the Python extension's Select Interpreter command to change it.

R

  • shiny.r.port: The port number to listen on when running a Shiny app. (By default, 0, which will choose a random port for each workspace.)
  • shiny.r.devmode: When true (default), Shiny for R apps are launched in developer mode.

About

License:MIT License


Languages

Language:TypeScript 98.5%Language:R 1.5%