terminalContext: Retrieve Information about RStudio Terminals

Description Usage Arguments Value Note Examples

View source: R/terminal.R

Description

Returns information about RStudio terminal instances.

Usage

1

Arguments

id

The terminal id. The id is obtained from terminalList(), terminalVisible(), terminalCreate(), or terminalExecute().

Value

A list with elements:

handle the internal handle
caption caption
title title set by the shell
working_dir working directory
shell shell type
running is terminal process executing
busy is terminal running a program
exit_code process exit code or NULL
connection websockets or rpc
sequence creation sequence
lines lines of text in terminal buffer
cols columns in terminal
rows rows in terminal
pid process id of terminal shell
full_screen full screen program running

Note

The terminalContext function was added in version 1.1.350 of RStudio.

Examples

1
2
3
4
5
6
## Not run: 
termId <- rstudioapi::terminalCreate("example", show = FALSE)
View(rstudioapi::terminalContext(termId))


## End(Not run)

rstudio/rstudioapi documentation built on Feb. 16, 2019, 5:42 a.m.