PyCharm 2020.2 Help

Run and debug R scripts

Run an R script

  1. Click Run the R file on the R file toolbar.

  2. Analyze results in the R console and R Tools windows.

    The R console launches and displays the execution results sent to the standard output. PyCharm also opens the Plots tab of the R Tools window if the script renders any visual content.

    Running an R script and rendering graphics

    If the R script involves any JavaScript visualization libraries, the results will be rendered in the Viewer window.

  3. Click Copy to clipboard to copy the generated plot in the clipboard. If needed, save the results. Click Export table in the Plots tab to export the plotted content in a .png file.

    You can drag the lower-left corner of of the preview area to adjust the image size. Select Open after saving checkbox if you want to continue processing the image.

    Export graphics

    Click Export table in the table view to save the table in a .csv file.

The Variables tab of the R console helps you analyze the values of the variables during script execution. The icon on the left of each variable indicates its type:

  • array: array

  • primitive: primitive

  • value: object

  • table-view: table

View variables

  • To preview not only a value of a particular variable but its size and the corresponding class click View options on the Variables toolbar to select required options:

    View options
  • Click a View link to preview the array value in the popup and a View Table link to preview data as a table in the editor.

    Previewing data in the Table View

    You can filter out the data in the table, structure the table in pages, and define the amount of rows per each page.

  • Click Import Data on the Variables toolbar to import CSV, TSV, or XLS file. Specify the data set and select the delimiter to preview the data in a tabular form:

    Import a CSV file

    The data are added to the global variables and can be accessed from the global environment.

    Import data file

You can execute your R files as a runnable process, job. Jobs are shown in a separate tab in the R console

Run jobs

  1. Open any R file in the editor and click Run job on the R file toolbar.

  2. Specify the way you want to process the results of the job execution. You can restrict copying it, copy to the global environment, or copy into a separate variable.

    Jobs settings

    The R script is executed and you can track its execution in the Jobs tab of the R console.

    Jobs

    Use the following icons of the Jobs toolbar:

    ItemDescription
    Add a jobAdd a new job.
    Delete jobsClear the list of jobs.
    Rerun the jobRerun the job.
  3. Switch to the Variables tab of the R console to check the execution results.

    Results are copied into the global environment
    Results are copied into a separate variable

You can debug your R script to detect any errors in the code.

Debug an R script

  1. Click the gutter to create breakpoints.

  2. Click Debug the R file on the R file toolbar.

    The debugging process stops at a breakpoint and you can preview the current results in the Variables window.

    Debugging an R script in PyCharm
  3. Control the script execution with the debugging toolbar:

    ItemTooltip and ShortcutDescription
    Resume Debug When the current application is stopped at a breakpoint, click this button to resume execution. When an application is running, this button toggles to Restart.
    PausePause Program

    Click this button to pause program execution.

    StopStopClick this button to terminate the current process.
    Step overStep Over
    F8
    Click this button to execute the program until the next line in the current method or file, skipping the methods referenced at the current execution point (if any). If the current line is the last one in the method, execution steps to the line executed right after this method.
    Step intoStep Into

    Click this button to have the debugger step into the method called at the current execution point.

    Step outStep Out Click this button to have the debugger step out of the current method, to the line executed right after it.
    Run to cursor

    Run to cursor

    Click this button to resume program execution and pause until the execution point reaches the line at the current cursor location in the editor. No breakpoint is required. Actually, there is a temporary breakpoint set for the current line at the caret, which is removed once program execution is paused. Thus, if the caret is positioned at the line which has already been executed, the program will be just resumed for further execution, because there is no way to roll back to previous breakpoints. This action is especially useful when you have stepped deep into the methods sequence and need to step out of several methods at once.

    If there are breakpoints set for the lines that should be executed before bringing you to the specified line, the debugger will pause at the first encountered breakpoint.

    Use this action when you need a kind of a temporary breakpoint at a specific line, where program execution should not be interrupted.

    View breakpointsView Breakpoints

    Click this button to open the Breakpoints dialog where you can configure R breakpoints behavior.

    View R specific breakpoints
    Mute breakpointsMute Breakpoints

    Use this button to toggle breakpoints status.

    When the icons.debugger.muteBreakpoints.svg button is pressed in the toolbar of the Debug tool window, all the breakpoints in a project are muted, and their icons become grey: muted breakpoint png.

    You can temporarily mute all the breakpoints in a project to execute the program without stopping at breakpoints.

    Evaluate expressionEvaluate Expression Click this button to open the Evaluate Expression dialog.

To execute or debug a code fragment, select the fragment and press Run selection or Debug selection. When running code fragments, mind code dependencies. All variables used in the executed fragments must be initialized.

Last modified: 02 September 2020