File: sendToConsole.Rd

package info (click to toggle)
r-cran-rstudioapi 0.14-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 892 kB
  • sloc: makefile: 2
file content (36 lines) | stat: -rw-r--r-- 985 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/stubs.R
\name{sendToConsole}
\alias{sendToConsole}
\title{Send code to the R console}
\usage{
sendToConsole(code, execute = TRUE, echo = TRUE, focus = TRUE, animate = FALSE)
}
\arguments{
\item{code}{The \R code to be executed, as a character vector.}

\item{execute}{Boolean; should the code be executed after being submitted
to the console? If \code{FALSE}, \code{code} is submitted to the console but is
not executed.}

\item{echo}{Boolean; echo the code in the console as it is executed?}

\item{focus}{Boolean; focus the console after sending code?}

\item{animate}{Boolean; should the submitted code be animated, as if someone was typing it?}
}
\description{
Send code to the R console, and optionally execute it.
}
\note{
The \code{sendToConsole} function was added in version 0.99.787 of
RStudio.
}
\examples{

\dontrun{
rstudioapi::sendToConsole(".Platform", execute = FALSE, animate = TRUE)
}


}