script.open: Open, Close and Save R Script in RStudio

Description

The function script.open opens an R script, R markdown script, or SQL script in RStudio, the function script.close closes an R script, and the function script.save saves an R script. Note that the R script need to have a file location before the script can be saved.

Usage

script.open(path, line = 1, col = 1, cursor = TRUE, run = FALSE,
            echo = TRUE, max.length = 999, spaced = TRUE, check = TRUE)
script.close(save = FALSE, check = TRUE)
script.save(all = FALSE, check = TRUE)

Arguments

path: a character string indicating the path of the script.
line: a numeric value indicating the line in the script to navigate to.
col: a numeric value indicating the column in the script to navigate to.
cursor: logical: if TRUE (default), the cursor moves to the requested location after opening the document.
run: logical: if TRUE, the code is executed after the document is opened
echo: logical: if TRUE (default), each expression is printed after parsing, before evaluation.
max.length: a numeric value indicating the maximal number of characters output for the deparse of a single expression.
spaced: logical: if TRUE (default), empty line is printed before each expression.
save: logical: if TRUE, the script is saved before closing when using the function script.close.
all: logical: if TRUE, all scripts opened in RStudio are saved when using the function script.save.
check: logical: if TRUE (default), argument specification is checked.

Author

Takuya Yanagida takuya.yanagida@univie.ac.at

References

Ushey, K., Allaire, J., Wickham, H., & Ritchie, G. (2023). rstudioapi: Safely access the RStudio API. R package version 0.15.0 https://CRAN.R-project.org/package=rstudioapi

Examples

Run this code

if (FALSE) {

# Example 1: Open  R script file
script.open("script.R")

# Example 2: Open  R script file and run the code
script.open("script.R", run = TRUE)

# Example 3: Close current R script file
script.close()

# Example 4: Save current R script
script.save()

# Example 5: Save all R scripts
script.save(all = TRUE)
}