• Stars
    star
    289
  • Rank 140,902 (Top 3 %)
  • Language
    R
  • License
    Other
  • Created about 8 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Call R from R

callr

Call R from R

lifecycle R-CMD-check CRAN RStudio mirror downloads Codecov test coverage

It is sometimes useful to perform a computation in a separate R process, without affecting the current R process at all. This packages does exactly that.


Features

  • Calls an R function, with arguments, in a subprocess.
  • Copies function arguments to the subprocess and copies the return value of the function back, seamlessly.
  • Copies error objects back from the subprocess, including a stack trace.
  • Shows and/or collects the standard output and standard error of the subprocess.
  • Supports both one-off and persistent R subprocesses.
  • Calls the function synchronously or asynchronously (in the background).
  • Can call R CMD commands, synchronously or asynchronously.
  • Can call R scripts, synchronously or asynchronously.
  • Provides extensible r_process, rcmd_process and rscript_process R6 classes, based on processx::process.

Installation

Install the stable version from CRAN:

install.packages("callr")

Synchronous, one-off R processes

Use r() to run an R function in a new R process. The results are passed back seamlessly:

callr::r(function() var(iris[, 1:4]))

Passing arguments

You can pass arguments to the function by setting args to the list of arguments. This is often necessary as these arguments are explicitly copied to the child process, whereas the evaluated function cannot refer to variables in the parent. For example, the following does not work:

mycars <- cars
callr::r(function() summary(mycars))

But this does:

mycars <- cars
callr::r(function(x) summary(x), args = list(mycars))

Note that the arguments will be serialized and saved to a file, so if they are large R objects, it might take a long time for the child process to start up.

Using packages

You can use any R package in the child process, just make sure to refer to it explicitly with the :: operator. For example, the following code creates an igraph graph in the child, and calculates some metrics of it.

callr::r(function() { g <- igraph::sample_gnp(1000, 4/1000); igraph::diameter(g) })

Error handling

callr copies errors from the child process back to the main R session:

callr::r(function() 1 + "A")
callr sets the `.Last.error` variable, and after an error you can inspect this for more details about the error, including stack traces both from the main R process and the subprocess.
.Last.error

The error objects has two parts. The first belongs to the main process, and the second belongs to the subprocess.

.Last.error also includes a stack trace, that includes both the main R process and the subprocess:

The top part of the trace contains the frames in the main process, and the bottom part contains the frames in the subprocess, starting with the anonymous function.

Standard output and error

By default, the standard output and error of the child is lost, but you can request callr to redirect them to files, and then inspect the files in the parent:

x <- callr::r(function() { print("hello world!"); message("hello again!") },
  stdout = "/tmp/out", stderr = "/tmp/err"
)
readLines("/tmp/out")
readLines("/tmp/err")

With the stdout option, the standard output is collected and can be examined once the child process finished. The show = TRUE options will also show the output of the child, as it is printed, on the console of the parent.

Background R processes

r_bg() is similar to r() but it starts the R process in the background. It returns an r_process R6 object, that provides a rich API:

rp <- callr::r_bg(function() Sys.sleep(.2))
rp

This is a list of all r_process methods:

ls(rp)

These include all methods of the processx::process superclass and the new get_result() method, to retrieve the R object returned by the function call. Some of the handiest methods are:

  • get_exit_status() to query the exit status of a finished process.
  • get_result() to collect the return value of the R function call.
  • interrupt() to send an interrupt to the process. This is equivalent to a CTRL+C key press, and the R process might ignore it.
  • is_alive() to check if the process is alive.
  • kill() to terminate the process.
  • poll_io() to wait for any standard output, standard error, or the completion of the process, with a timeout.
  • read_*() to read the standard output or error.
  • suspend() and resume() to stop and continue a process.
  • wait() to wait for the completion of the process, with a timeout.

Multiple background R processes and poll()

Multiple background R processes are best managed with the processx::poll() function that waits for events (standard output/error or termination) from multiple processes. It returns as soon as one process has generated an event, or if its timeout has expired. The timeout is in milliseconds.

rp1 <- callr::r_bg(function() { Sys.sleep(1/2); "1 done" })
rp2 <- callr::r_bg(function() { Sys.sleep(1/1000); "2 done" })
processx::poll(list(rp1, rp2), 1000)
rp2$get_result()
processx::poll(list(rp1), 1000)
rp1$get_result()

Persistent R sessions

r_session is another processx::process subclass that represents a persistent background R session:

rs <- callr::r_session$new()
rs

r_session$run() is a synchronous call, that works similarly to r(), but uses the persistent session. r_session$call() starts the function call and returns immediately. The r_session$poll_process() method or processx::poll() can then be used to wait for the completion or other events from one or more R sessions, R processes or other processx::process objects.

Once an R session is done with an asynchronous computation, its poll_process() method returns "ready" and the r_session$read() method can read out the result.

rs <- callr::r_session$new()
rs$run(function() runif(10))
rs$call(function() rnorm(10))
rs
rs$poll_process(2000)
rs$read()

Running R CMD commands

The rcmd() function calls an R CMD command. For example, you can call R CMD INSTALL, R CMD check or R CMD config this way:

callr::rcmd("config", "CC")

This returns a list with three components: the standard output, the standard error, and the exit (status) code of the R CMD command.

Code of Conduct

Please note that the callr project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

MIT © Mango Solutions, RStudio

More Repositories

1

devtools

Tools to make an R developer's life easier
R
2,368
star
2

lintr

Static Code Analysis for R
R
1,164
star
3

httr

httr: a friendly http package for R
R
982
star
4

actions

GitHub Actions for the R community
TypeScript
917
star
5

testthat

An R 📦 to make testing 😀
R
867
star
6

usethis

Set up commonly used 📦 components
R
821
star
7

pkgdown

Generate static html documentation for an R package
R
708
star
8

styler

Non-invasive pretty printing of R code
R
692
star
9

pak

A fresh approach to package installation
C
630
star
10

cli

Tools for making beautiful & useful command line interfaces
R
618
star
11

roxygen2

Generate R package documentation from inline R comments
R
579
star
12

rig

The R Installation Manager
Rust
555
star
13

rlang

Low-level API for programming with R
R
484
star
14

progress

Progress bar in your R terminal
R
457
star
15

R6

Encapsulated object-oriented programming for R
R
402
star
16

here

A simpler way to find your files
R
401
star
17

scales

Tools for ggplot2 scales
R
388
star
18

fs

Provide cross platform file operations based on libuv.
C
361
star
19

rex

Friendly regular expressions for R.
R
331
star
20

covr

Test coverage reports for R
R
329
star
21

crayon

🖍️ R package for colored terminal output — now superseded by cli
R
322
star
22

remotes

Install R packages from GitHub, GitLab, Bitbucket, git, svn repositories, URLs
R
321
star
23

memoise

Easy memoisation for R
R
314
star
24

lobstr

Understanding complex R objects with tools similar to str()
R
296
star
25

slider

Sliding Window Functions
R
290
star
26

vctrs

Generic programming with typed R vectors
C
280
star
27

waldo

Find differences between R objects
R
275
star
28

zeallot

Variable assignment with zeal! (or multiple, unpacking, and destructuring assignment in R)
R
250
star
29

conflicted

An alternative conflict resolution strategy for R
R
243
star
30

bench

High Precision Timing of R Expressions
R
242
star
31

gmailr

Access the Gmail RESTful API from R.
R
230
star
32

processx

Execute and Control Subprocesses from R
R
227
star
33

httr2

Make HTTP requests and process their responses. A modern reimagining of httr.
R
223
star
34

asciicast

Turn R scripts into terminal screencasts
R
223
star
35

xml2

Bindings to libxml2
R
218
star
36

gh

Minimalistic GitHub API client in R
R
217
star
37

cpp11

cpp11 helps you to interact with R objects using C++ code.
C++
193
star
38

keyring

🔐 Access the system credential store from R
R
188
star
39

vdiffr

Visual regression testing and graphical diffing with testthat
C++
181
star
40

svglite

A lightweight svg graphics device for R
C++
178
star
41

pillar

Format columns with colour
R
173
star
42

ragg

Graphic Devices Based on AGG
C++
170
star
43

withr

Methods For Temporarily Modifying Global State
R
169
star
44

hugodown

Make websites with hugo and RMarkdown
R
165
star
45

ymlthis

write YAML for R Markdown, bookdown, blogdown, and more
R
163
star
46

coro

Coroutines for R
R
150
star
47

rprojroot

Finding files in project subdirectories
R
147
star
48

debugme

Easy and efficient debugging for R packages
R
145
star
49

available

Check if a package name is available to use
R
142
star
50

archive

R bindings to libarchive, supporting a large variety of archive formats
C++
141
star
51

ellipsis

Tools for Working with ...
R
139
star
52

later

Schedule an R function or formula to run after a specified period of time.
C++
136
star
53

gert

Simple git client for R
C
136
star
54

itdepends

R
133
star
55

rray

Simple Arrays
R
130
star
56

isoband

isoband: An R package to generate contour lines and polygons.
C++
130
star
57

prettyunits

Pretty, human readable formatting of quantities
JavaScript
128
star
58

fastmap

Fast map implementation for R
C++
127
star
59

desc

Manipulate DESCRIPTION files
R
121
star
60

tidyselect

A backend for functions taking tidyverse selections
R
121
star
61

gargle

Infrastructure for calling Google APIs from R, including auth
R
113
star
62

rcmdcheck

Run R CMD check from R and collect the results
R
109
star
63

evaluate

A version of eval for R that returns more information about what happened
R
108
star
64

prettycode

Syntax highlight R code in the terminal
R
100
star
65

sloop

S language OOP ⛵️
R
99
star
66

revdepcheck

R package reverse dependency checking
R
99
star
67

mockery

A mocking library for R.
R
98
star
68

tree-sitter-r

C
95
star
69

clock

A Date-Time Library for R
R
95
star
70

pkgdepends

R Package Dependency Resolution
R
93
star
71

systemfonts

System Native Font Handling in R
C++
91
star
72

lifecycle

Manage the life cycle of your exported functions and arguments
R
90
star
73

gtable

The layout packages that powers ggplot2
R
85
star
74

askpass

Password Entry for R, Git, and SSH
R
83
star
75

commonmark

High Performance CommonMark and Github Markdown Rendering in R
C
83
star
76

zip

Platform independent zip compression via miniz
C
82
star
77

rappdirs

Find OS-specific directories to store data, caches, and logs. A port of python's AppDirs
R
81
star
78

downlit

Syntax Highlighting and Automatic Linking
R
81
star
79

clisymbols

Unicode symbols for CLI applications, with fallbacks
R
76
star
80

ps

R package to query, list, manipulate system processes
C
72
star
81

sessioninfo

Print Session Information
R
72
star
82

pkgapi

Create a map of functions for an R package - WORK IN PROGRESS!
R
70
star
83

credentials

Tools for Managing SSH and Git Credentials
R
70
star
84

sodium

R bindings to libsodium
R
68
star
85

roxygen2md

Convert elements of roxygen documentation to markdown
R
67
star
86

backports

Reimplementations of Functions Introduced Since R-3.0.0
R
65
star
87

pkgbuild

Find tools needed to build R packages
R
65
star
88

webfakes

Fake web apps for HTTP testing R packages
C
61
star
89

cliapp

Rich Command Line Applications
R
60
star
90

generics

Common generic methods
R
59
star
91

diffviewer

HTML widget to visually compare files
JavaScript
57
star
92

liteq

Serverless R message queue using SQLite
R
56
star
93

pkgload

Simulate installing and loading a package
R
54
star
94

cachem

Key-value caches for R
R
53
star
95

carrier

Create standalone functions for remote execution
R
50
star
96

brio

Basic R Input Output
R
50
star
97

marquee

Markdown Parser and Renderer for R Graphics
C
49
star
98

jose

Javascript Object Signing and Encryption for R
R
48
star
99

urlchecker

Run CRAN URL checks from older versions of R
R
45
star
100

pkgconfig

Private configuration for R packages
R
41
star