, OBiBa group [cph]| Title: | 'Rock' R Server Client |
|---|---|
| Description: | Connector to the REST API of a 'Rock' R server, to perform operations on a remote R server session, or administration tasks. See 'Rock' documentation at <https://rockdoc.obiba.org/>. |
| Authors: | Yannick Marcon [aut, cre]
, OBiBa group [cph] |
| Maintainer: | Yannick Marcon <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 1.0.0 |
| Built: | 2025-02-16 05:16:44 UTC |
| Source: | https://github.com/cran/rockr |
Assign an R expression or R data to a symbol in the remote R session.
rockr.assign(conn, symbol, value, async = FALSE)rockr.assign(conn, symbol, value, async = FALSE)
conn |
A rockr connection object. |
symbol |
Name of the R symbol. |
value |
Value to assign to the symbol: can be a data value or a R script to execute. |
async |
R script is executed asynchronously within the session (default is FALSE). If TRUE, the value returned is the ID of the command to look for. |
The command object if async is TRUE
Other assignment functions:
rockr.assign.data(),
rockr.assign.expr()
## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.assign(conn, "mtcars", mtcars) rockr.assign(conn, "x", 123) rockr.assign(conn, "y", "abc") rockr.assign(conn, "z", quote(tibble::tribble( ~colA, ~colB, 'a', 1, 'b', 2, 'c', 3 ))) rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.assign(conn, "mtcars", mtcars) rockr.assign(conn, "x", 123) rockr.assign(conn, "y", "abc") rockr.assign(conn, "z", quote(tibble::tribble( ~colA, ~colB, 'a', 1, 'b', 2, 'c', 3 ))) rockr.close(conn) ## End(Not run)
Assign an R object to a R symbol in the remote R session.
rockr.assign.data(conn, symbol, value, async = FALSE)rockr.assign.data(conn, symbol, value, async = FALSE)
conn |
A rockr connection object. |
symbol |
Name of the R symbol. |
value |
The R object to assign (data.frame, vector, etc.). |
async |
R script is executed asynchronously within the session (default is FALSE). If TRUE, the value returned is the ID of the command to look for. |
The command object if async is TRUE
Other assignment functions:
rockr.assign.expr(),
rockr.assign()
## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) # push a data frame to the R server rockr.assign.data(o, "D", mtcars) # push a vector to the R server rockr.assign.data(o, "C", mtcars$cyl) # push a string rockr.assign.data(o, "S", "Hello!") ## End(Not run)## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) # push a data frame to the R server rockr.assign.data(o, "D", mtcars) # push a vector to the R server rockr.assign.data(o, "C", mtcars$cyl) # push a string rockr.assign.data(o, "S", "Hello!") ## End(Not run)
Assign an R expression to a symbol in the remote R session.
rockr.assign.expr(conn, symbol, value, async = FALSE)rockr.assign.expr(conn, symbol, value, async = FALSE)
conn |
A rockr connection object. |
symbol |
Name of the R symbol. |
value |
Value to assign to the symbol: can be a primitive value or a R script to execute. |
async |
R script is executed asynchronously within the session (default is FALSE). If TRUE, the value returned is the ID of the command to look for. |
The command object if async is TRUE
Other assignment functions:
rockr.assign.data(),
rockr.assign()
## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.assign.expr(conn, "x", 123) rockr.assign.expr(conn, "y", "abc") rockr.assign.expr(conn, "z", quote(tibble::tribble( ~colA, ~colB, 'a', 1, 'b', 2, 'c', 3 ))) rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.assign.expr(conn, "x", 123) rockr.assign.expr(conn, "y", "abc") rockr.assign.expr(conn, "z", quote(tibble::tribble( ~colA, ~colB, 'a', 1, 'b', 2, 'c', 3 ))) rockr.close(conn) ## End(Not run)
Close the R session, if there is any associated to the connection.
rockr.close(conn)rockr.close(conn)
conn |
A rockr connection object. |
Void
Other connection functions:
rockr.connect(),
rockr.open()
## Not run: conn <- rockr.connect('administrator','password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect('administrator','password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.close(conn) ## End(Not run)
Get an asynchronous R commands in the remote R session.
rockr.command(conn, id, wait = FALSE)rockr.command(conn, id, wait = FALSE)
conn |
A rockr connection object. |
id |
R command ID. |
wait |
Wait for the command to complete. |
The command object.
Other command functions:
rockr.command_result(),
rockr.command_rm(),
rockr.commands_rm(),
rockr.commands()
## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.command(conn, '1234') rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.command(conn, '1234') rockr.close(conn) ## End(Not run)
Get the result of an asynchronous R commands in the remote R session. The command is removed from the remote R session after this call.
rockr.command_result(conn, id, wait = FALSE, rm = TRUE)rockr.command_result(conn, id, wait = FALSE, rm = TRUE)
conn |
A rockr connection object. |
id |
R command ID. |
wait |
Wait for the command to complete (default is FALSE). |
rm |
Remove command from the list of asynchronous commands after retrieving the result (default is TRUE). |
The command result as an unserialized object.
Other command functions:
rockr.command_rm(),
rockr.commands_rm(),
rockr.commands(),
rockr.command()
## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.command_result(conn, '1234') rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.command_result(conn, '1234') rockr.close(conn) ## End(Not run)
Remove an asynchronous R commands in the remote R session.
rockr.command_rm(conn, id)rockr.command_rm(conn, id)
conn |
A rockr connection object. |
id |
R command ID. |
Void
Other command functions:
rockr.command_result(),
rockr.commands_rm(),
rockr.commands(),
rockr.command()
## Not run: conn <- rockr.connect('administrator','password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.command_rm(conn, '1234') rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect('administrator','password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.command_rm(conn, '1234') rockr.close(conn) ## End(Not run)
Get the list of asynchronous R commands in the remote R session.
rockr.commands(conn, df = TRUE)rockr.commands(conn, df = TRUE)
conn |
A rockr connection object. |
df |
Return a data.frame (default is TRUE) |
The data.frame of command objects, one column per property.
Other command functions:
rockr.command_result(),
rockr.command_rm(),
rockr.commands_rm(),
rockr.command()
## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.commands(conn) rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.commands(conn) rockr.close(conn) ## End(Not run)
Remove all asynchronous R commands in the remote R session.
rockr.commands_rm(conn)rockr.commands_rm(conn)
conn |
A rockr connection object. |
Void
Other command functions:
rockr.command_result(),
rockr.command_rm(),
rockr.commands(),
rockr.command()
## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.commands_rm(conn) rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.commands_rm(conn) rockr.close(conn) ## End(Not run)
Connect with Rocker.
rockr.connect( username = getOption("rock.username"), password = getOption("rock.password"), url = getOption("rock.url"), opts = getOption("rock.opts", list()) )rockr.connect( username = getOption("rock.username"), password = getOption("rock.password"), url = getOption("rock.url"), opts = getOption("rock.opts", list()) )
username |
User name in Rocker R server. Can be provided by "rock.username" option. |
password |
User password in Rocker R server. Can be provided by "rock.password" option. |
url |
Rocker R server url. Can be provided by "rock.url" option. |
opts |
Curl options as described by httr (call httr::httr_options() for details). Can be provided by "rock.opts" option. |
A rockr connection object.
Other connection functions:
rockr.close(),
rockr.open()
## Not run: #### The below examples illustrate the different ways to connect to rockr #### # explicit username/password connection conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') # explicit access token connection conn <- rockr.connect(token='HYG16LO0VaX4O0UardNbiqmr2ByBpRke', url='https://rocker-demo.obiba.org') # connect using options and user credentials options(rockr.username='administrator', rockr.password='password', rockr.url='https://rocker-demo.obiba.org') conn <- rockr.connect() # connect using options and personal access token options(rockr.token='HYG16LO0VaX4O0UardNbiqmr2ByBpRke', rockr.url='https://rocker-demo.obiba.org') conn <- rockr.connect() # connect using ssl key pair options(rockr.opts=list( sslcert='my-publickey.pem', sslkey='my-privatekey.pem')) conn <- rockr.connect(url='https://rocker-demo.obiba.org') ## End(Not run)## Not run: #### The below examples illustrate the different ways to connect to rockr #### # explicit username/password connection conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') # explicit access token connection conn <- rockr.connect(token='HYG16LO0VaX4O0UardNbiqmr2ByBpRke', url='https://rocker-demo.obiba.org') # connect using options and user credentials options(rockr.username='administrator', rockr.password='password', rockr.url='https://rocker-demo.obiba.org') conn <- rockr.connect() # connect using options and personal access token options(rockr.token='HYG16LO0VaX4O0UardNbiqmr2ByBpRke', rockr.url='https://rocker-demo.obiba.org') conn <- rockr.connect() # connect using ssl key pair options(rockr.opts=list( sslcert='my-publickey.pem', sslkey='my-privatekey.pem')) conn <- rockr.connect(url='https://rocker-demo.obiba.org') ## End(Not run)
Execute a R script in the remote R session.
rockr.eval(conn, script, json = FALSE, async = FALSE)rockr.eval(conn, script, json = FALSE, async = FALSE)
conn |
A rockr connection object. |
script |
R script to execute. |
json |
Response is in JSON format or an object serialized by R. Default is FALSE. |
async |
R script is executed asynchronously within the session (default is FALSE). If TRUE, the value returned is the command object to look for. |
The unserialized result object.
Other evaluation functions:
rockr.eval.source()
## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.eval(conn, "x <- 'foo'") rockr.eval(conn, "ls()") rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.eval(conn, "x <- 'foo'") rockr.eval(conn, "ls()") rockr.close(conn) ## End(Not run)
Upload a R file script and execute it in the remote R session with source().
rockr.eval.source(conn, path, json = FALSE, async = FALSE)rockr.eval.source(conn, path, json = FALSE, async = FALSE)
conn |
A rockr connection object. |
path |
Path to the R file script to execute. |
json |
Response is in JSON format or an object serialized by R. Default is FALSE. |
async |
R script is executed asynchronously within the session (default is FALSE). If TRUE, the value returned is the command object to look for. |
The unserialized result object.
Other evaluation functions:
rockr.eval()
## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.eval.source(conn, "myscript.R") rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.eval.source(conn, "myscript.R") rockr.close(conn) ## End(Not run)
Download a file or a folder from the Rocker R session working directory.
rockr.file_download( conn, source, destination = NULL, overwrite = FALSE, temp = FALSE )rockr.file_download( conn, source, destination = NULL, overwrite = FALSE, temp = FALSE )
conn |
A rockr connection object. |
source |
Path to the file in the R server file system. |
destination |
Path to the file to be written. If omitted, file with same name in the working directory will be written. Any non-existing parent directories will be created. |
overwrite |
Overwrite the destination file if TRUE. Default is FALSE. |
temp |
Logical to specify whether the root folder is the R session's home or the temporary folder. Default is FALSE. |
Void
Other file functions:
rockr.file_upload()
## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) # download a file rockr.file_download(conn, 'data.csv') # download, create destination folder and rename file rockr.file_download(conn, 'DatabaseTest.sav', 'spss/test.sav') rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) # download a file rockr.file_download(conn, 'data.csv') # download, create destination folder and rename file rockr.file_download(conn, 'DatabaseTest.sav', 'spss/test.sav') rockr.close(conn) ## End(Not run)
Upload a file into the Rocker R session working directory.
rockr.file_upload( conn, source, destination = NULL, overwrite = FALSE, temp = FALSE )rockr.file_upload( conn, source, destination = NULL, overwrite = FALSE, temp = FALSE )
conn |
A rockr connection object. |
source |
Path to the file in the local file system. |
destination |
Path of the destination file in the Rocker R session. Root folder is the session's home or temporary folder (see 'temp' parameter). If empty (default behavior), the destination file name will be the same as the source one. |
overwrite |
Overwrite the destination file if TRUE. Default is FALSE. |
temp |
Logical to specify whether the root folder is the R session's home or the temporary folder. Default is FALSE. |
Void
Other file functions:
rockr.file_download()
## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) # upload a file rockr.file_upload(conn, 'data.csv') # download, create destination folder and rename file rockr.file_upload(conn, 'DatabaseTest.sav', '/spss/test.sav') # upload a folder rockr.file_upload(conn, 'input') rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='user', password='password', url='https://rocker-demo.obiba.org') rockr.open(conn) # upload a file rockr.file_upload(conn, 'data.csv') # download, create destination folder and rename file rockr.file_upload(conn, 'DatabaseTest.sav', '/spss/test.sav') # upload a folder rockr.file_upload(conn, 'input') rockr.close(conn) ## End(Not run)
Get the tail of the R server log.
rockr.log(conn, limit = 100)rockr.log(conn, limit = 100)
conn |
A rockr connection object. |
limit |
The number of lines in the tail. |
A vector of character strings, one per log file line.
Other administration functions:
rockr.package_install(),
rockr.package_rm(),
rockr.packages_datashield(),
rockr.packages_rm(),
rockr.packages(),
rockr.package(),
rockr.restart(),
rockr.session_switch(),
rockr.sessions(),
rockr.session(),
rockr.start(),
rockr.status(),
rockr.stop(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.log(conn, 10) ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.log(conn, 10) ## End(Not run)
Open a R session, and store the session object within the connection object.
rockr.open(conn)rockr.open(conn)
conn |
A rockr connection object. |
Void
Other connection functions:
rockr.close(),
rockr.connect()
## Not run: conn <- rockr.connect('administrator','password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect('administrator','password', url='https://rocker-demo.obiba.org') rockr.open(conn) rockr.close(conn) ## End(Not run)
Get the package description from the R server.
rockr.package(conn, name)rockr.package(conn, name)
conn |
A rockr connection object. |
name |
The package name. |
The R package description object.
Other administration functions:
rockr.log(),
rockr.package_install(),
rockr.package_rm(),
rockr.packages_datashield(),
rockr.packages_rm(),
rockr.packages(),
rockr.restart(),
rockr.session_switch(),
rockr.sessions(),
rockr.session(),
rockr.start(),
rockr.status(),
rockr.stop(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.package(conn, 'tibble') ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.package(conn, 'tibble') ## End(Not run)
Install a package in the R server. Package can be in different kind of repositories: CRAN, GitHub or Bioconductor.
rockr.package_install(conn, name, ref = NULL, manager = "cran")rockr.package_install(conn, name, ref = NULL, manager = "cran")
conn |
A rockr connection object. |
name |
The package name or identifier in the source code repository. |
ref |
The branch/commit number of the source code repositories. |
manager |
The package manager: cran, github (gh), bioconductor (bioc). |
Void
Other administration functions:
rockr.log(),
rockr.package_rm(),
rockr.packages_datashield(),
rockr.packages_rm(),
rockr.packages(),
rockr.package(),
rockr.restart(),
rockr.session_switch(),
rockr.sessions(),
rockr.session(),
rockr.start(),
rockr.status(),
rockr.stop(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.package_install(conn, 'tibble') ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.package_install(conn, 'tibble') ## End(Not run)
Remove a package from the R server.
rockr.package_rm(conn, name)rockr.package_rm(conn, name)
conn |
A rockr connection object. |
name |
The package name. |
Void
Other administration functions:
rockr.log(),
rockr.package_install(),
rockr.packages_datashield(),
rockr.packages_rm(),
rockr.packages(),
rockr.package(),
rockr.restart(),
rockr.session_switch(),
rockr.sessions(),
rockr.session(),
rockr.start(),
rockr.status(),
rockr.stop(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.package_rm(conn, 'tibble') ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.package_rm(conn, 'tibble') ## End(Not run)
Get the list of packages from the R server.
rockr.packages(conn)rockr.packages(conn)
conn |
A rockr connection object. |
The matrix of the R packages, same as the one from install.packages().
Other administration functions:
rockr.log(),
rockr.package_install(),
rockr.package_rm(),
rockr.packages_datashield(),
rockr.packages_rm(),
rockr.package(),
rockr.restart(),
rockr.session_switch(),
rockr.sessions(),
rockr.session(),
rockr.start(),
rockr.status(),
rockr.stop(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.packages(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.packages(conn) ## End(Not run)
Discover the list of DataSHIELD packages and their settings from the R server.
rockr.packages_datashield(conn)rockr.packages_datashield(conn)
conn |
A rockr connection object. |
The list of the DataSHIELD R packages properties (AggregateMethods, AssignMethods, Options)
Other administration functions:
rockr.log(),
rockr.package_install(),
rockr.package_rm(),
rockr.packages_rm(),
rockr.packages(),
rockr.package(),
rockr.restart(),
rockr.session_switch(),
rockr.sessions(),
rockr.session(),
rockr.start(),
rockr.status(),
rockr.stop(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.packages_datashield(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.packages_datashield(conn) ## End(Not run)
Remove some packages from the R server.
rockr.packages_rm(conn, names)rockr.packages_rm(conn, names)
conn |
A rockr connection object. |
names |
The package names. |
Void
Other administration functions:
rockr.log(),
rockr.package_install(),
rockr.package_rm(),
rockr.packages_datashield(),
rockr.packages(),
rockr.package(),
rockr.restart(),
rockr.session_switch(),
rockr.sessions(),
rockr.session(),
rockr.start(),
rockr.status(),
rockr.stop(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.packages_rm(conn, c('rlang', 'tibble')) ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.packages_rm(conn, c('rlang', 'tibble')) ## End(Not run)
Stop and start the R server. Any R sessions will be closed.
rockr.restart(conn)rockr.restart(conn)
conn |
A rockr connection object. |
Logical indicating wether the R server is running (invisible).
Other administration functions:
rockr.log(),
rockr.package_install(),
rockr.package_rm(),
rockr.packages_datashield(),
rockr.packages_rm(),
rockr.packages(),
rockr.package(),
rockr.session_switch(),
rockr.sessions(),
rockr.session(),
rockr.start(),
rockr.status(),
rockr.stop(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.stop(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.stop(conn) ## End(Not run)
Get a specific R session. Users with administrator or manager role can get any R sessions. Regular users can only get their own.
rockr.session(conn, id)rockr.session(conn, id)
conn |
A rockr connection object. |
id |
The R session id to look for. |
The R session object.
Other administration functions:
rockr.log(),
rockr.package_install(),
rockr.package_rm(),
rockr.packages_datashield(),
rockr.packages_rm(),
rockr.packages(),
rockr.package(),
rockr.restart(),
rockr.session_switch(),
rockr.sessions(),
rockr.start(),
rockr.status(),
rockr.stop(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.session(conn, '1234') ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.session(conn, '1234') ## End(Not run)
Change the R session that is attached to the connection object. This allows to interact with a R session after another. Of course proper permission apply when executing R operations on this R session.
rockr.session_switch(conn, session)rockr.session_switch(conn, session)
conn |
A rockr connection object. |
session |
A R session object. |
Void
Other administration functions:
rockr.log(),
rockr.package_install(),
rockr.package_rm(),
rockr.packages_datashield(),
rockr.packages_rm(),
rockr.packages(),
rockr.package(),
rockr.restart(),
rockr.sessions(),
rockr.session(),
rockr.start(),
rockr.status(),
rockr.stop(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') # open several R sessions rockr.open(conn) rockr.open(conn) sessions <- rockr.sessions(conn) # switch to first one rockr.session_switch(conn, sessions[[1]]) conn$session rockr.close(conn) # switch to 2nd one rockr.session_switch(conn, sessions[[2]]) conn$session rockr.close(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') # open several R sessions rockr.open(conn) rockr.open(conn) sessions <- rockr.sessions(conn) # switch to first one rockr.session_switch(conn, sessions[[1]]) conn$session rockr.close(conn) # switch to 2nd one rockr.session_switch(conn, sessions[[2]]) conn$session rockr.close(conn) ## End(Not run)
Get the list of the R sessions. Users with administrator or manager role can list the R sessions. Regular users can only list their own.
rockr.sessions(conn, subject = NULL)rockr.sessions(conn, subject = NULL)
conn |
A rockr connection object. |
subject |
Filter by subject name owning the sessions (requires administrator or manager role to be effective). |
The list of the R session objects.
Other administration functions:
rockr.log(),
rockr.package_install(),
rockr.package_rm(),
rockr.packages_datashield(),
rockr.packages_rm(),
rockr.packages(),
rockr.package(),
rockr.restart(),
rockr.session_switch(),
rockr.session(),
rockr.start(),
rockr.status(),
rockr.stop(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.sessions(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.sessions(conn) ## End(Not run)
Start the R server, if not already running.
rockr.start(conn)rockr.start(conn)
conn |
A rockr connection object. |
Logical indicating wether the R server is running (invisible).
Other administration functions:
rockr.log(),
rockr.package_install(),
rockr.package_rm(),
rockr.packages_datashield(),
rockr.packages_rm(),
rockr.packages(),
rockr.package(),
rockr.restart(),
rockr.session_switch(),
rockr.sessions(),
rockr.session(),
rockr.status(),
rockr.stop(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.start(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.start(conn) ## End(Not run)
Get the status of the R server, including information about the server node.
rockr.status(conn)rockr.status(conn)
conn |
A rockr connection object. |
The R server status object.
Other administration functions:
rockr.log(),
rockr.package_install(),
rockr.package_rm(),
rockr.packages_datashield(),
rockr.packages_rm(),
rockr.packages(),
rockr.package(),
rockr.restart(),
rockr.session_switch(),
rockr.sessions(),
rockr.session(),
rockr.start(),
rockr.stop(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.status(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.status(conn) ## End(Not run)
Stop the R server, if running. Any R sessions will be closed.
rockr.stop(conn)rockr.stop(conn)
conn |
A rockr connection object. |
Logical indicating wether the R server is running (invisible).
Other administration functions:
rockr.log(),
rockr.package_install(),
rockr.package_rm(),
rockr.packages_datashield(),
rockr.packages_rm(),
rockr.packages(),
rockr.package(),
rockr.restart(),
rockr.session_switch(),
rockr.sessions(),
rockr.session(),
rockr.start(),
rockr.status(),
rockr.version()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.stop(conn) ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.stop(conn) ## End(Not run)
Get the version object of the R server.
rockr.version(conn)rockr.version(conn)
conn |
A rockr connection object. |
A simple.list, same as R.version.
Other administration functions:
rockr.log(),
rockr.package_install(),
rockr.package_rm(),
rockr.packages_datashield(),
rockr.packages_rm(),
rockr.packages(),
rockr.package(),
rockr.restart(),
rockr.session_switch(),
rockr.sessions(),
rockr.session(),
rockr.start(),
rockr.status(),
rockr.stop()
## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.version(conn, 10) ## End(Not run)## Not run: conn <- rockr.connect(username='administrator', password='password', url='https://rocker-demo.obiba.org') rockr.version(conn, 10) ## End(Not run)