Control a remote R session from your local R session.
R
Switch branches/tags
Nothing to show
Clone or download
Latest commit 482b666 May 14, 2018
Permalink
Failed to load latest commit information.
R Fix Relay function bug May 13, 2018
inst tweak logging Jan 14, 2018
man update man Jan 5, 2018
tests Add tests back Jan 7, 2018
vignettes merge Jan 5, 2018
.Rbuildignore Add appveyor.yml Jan 5, 2018
.gitignore add covers Jun 15, 2017
.travis.yml appvryor again Jan 5, 2018
ChangeLog tweak logging Jan 14, 2018
DESCRIPTION logging fixed Jan 14, 2018
LICENSE add LICENSE.md Jun 15, 2017
LICENSE.md add LICENSE.md Jun 15, 2017
NAMESPACE fix namespace problem for real this time Jan 5, 2018
README.md tweak logging Jan 14, 2018
TODO fix s2c newname bug Jun 28, 2016
appveyor.yml Adjust appveyor Jan 7, 2018

README.md

remoter

Control a remote R session from your local R session. The package uses pbdZMQ to handle the communication and networking. Encryption is supported if the sodium package is (optionally) installed. Details below.

Installation

You can install the stable version from CRAN using the usual install.packages():

install.packages("remoter")

In order to be able to create and connect to secure servers, you need to also install the sodium package. The use of sodium is optional because it is a non-trivial systems dependency, but it is highly recommended. You can install it manually with a call to install.packages("sodium") or by installing remoter via:

install.packages("remoter", dependencies=TRUE)

The development version is maintained on GitHub, and can easily be installed by any of the packages that offer installations from GitHub:

### Pick your preference
devtools::install_github("RBigData/remoter")
ghit::install_github("RBigData/remoter")
remotes::install_github("RBigData/remoter")

To simplify installations on cloud systems, we also have a Docker container available.

Usage

For setting up a local server, you can do:

remoter::server()

And connect to it interactively via:

remoter::client()

There is also the option to pipe commands to the server in batch using the batch() function:

### Passing an R script file
remoter::batch(file="my_rscript_file.r")
### Passing in a script manually
remoter::batch(script="1+1")

For more details, including working with remote machines, see the package vignette.

Acknowledgements

Work for the remoter package was supported in part by the project Harnessing Scalable Libraries for Statistical Computing on Modern Architectures and Bringing Statistics to Large Scale Computing funded by the National Science Foundation Division of Mathematical Sciences under Grant No. 1418195.

Any opinions, findings, and conclusions or recommendations expressed in this material are those of the authors and do not necessarily reflect the views of the National Science Foundation.