Nothing
#-------------------------------------------------------------------------------
# Copyright (c) 2021 OBiBa. All rights reserved.
#
# This program and the accompanying materials
# are made available under the terms of the GNU Public License v3.0.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#-------------------------------------------------------------------------------
#' Get the R workspaces from a opal.
#'
#' @family workspace functions
#' @param opal Opal object.
#' @examples
#' \dontrun{
#' o <- opal.login('administrator','password', url='https://opal-demo.obiba.org')
#' opal.workspaces(o)
#' opal.logout(o)
#' }
#' @export
opal.workspaces <- function(opal) {
if (!is.na(opal$version) && opal.version_compare(opal,"2.6")<0) {
warning("Workspaces are not available for opal ", opal$version, " (2.6.0 or higher is required)")
} else {
query <- list(context='R')
wss <- opal.get(opal, "service", "r", "workspaces", query=query)
if (length(wss)) {
name <- c()
user <- c()
context <- c()
lastAccessDate <- c()
size <- c()
for (i in 1:length(wss)) {
ws <- wss[i]
name <- c(name, ws[[1]]$name)
user <- c(user, ws[[1]]$user)
context <- c(context, ws[[1]]$context)
lastAccessDate <- c(lastAccessDate, ws[[1]]$lastAccessDate)
size <- c(size, ws[[1]]$size)
}
data.frame(name=name, user=user, context=context, lastAccessDate=lastAccessDate, size=size)
}
}
}
#' Remove a R workspace from a opal.
#'
#' @family workspace functions
#' @param opal Opal object.
#' @param ws The workspace name
#' @param user The user name associated to the worskpace. If not provided, the current user is applied.
#' @examples
#' \dontrun{
#' o <- opal.login('administrator','password', url='https://opal-demo.obiba.org')
#' opal.workspace_rm(o, 'test')
#' opal.logout(o)
#' }
#' @export
opal.workspace_rm <- function(opal, ws, user=NULL) {
if (!is.na(opal$version) && opal.version_compare(opal,"2.6")<0) {
warning("Workspaces are not available for opal ", opal$version, " (2.6.0 or higher is required)")
} else {
u <- user
if (is.null(user)) {
u <- opal$username
}
if (is.null(u) || length(u) == 0) {
stop("User name is missing or empty.")
}
if (length(ws) == 0) {
stop("Workspace name is missing or empty.")
}
query <- list(context='R', name=ws, user=u)
ignore <- opal.delete(opal, "service", "r", "workspaces", query=query)
}
}
#' Save the current session in a opal R workspace.
#'
#' @family workspace functions
#' @param opal Opal object.
#' @param save Save the workspace with given identifier (default is TRUE, current session ID if TRUE).
#' @return The workspace ID (invisible)
#' @examples
#' \dontrun{
#' o <- opal.login('administrator','password', url='https://opal-demo.obiba.org')
#' # provide a workspace ID
#' opal.workspace_save(o, 'test')
#' # or use default one
#' id <- opal.workspace_save(o)
#' opal.logout(o)
#' }
#' @export
opal.workspace_save <- function(opal, save=TRUE) {
if (!is.na(opal$version) && opal.version_compare(opal,"2.6")<0) {
warning("Workspaces are not available for opal ", opal$version, " (2.6.0 or higher is required)")
} else {
saveId <- save
ignore <- .getRSessionId(opal)
if(is.logical(save) && save) {
saveId <- opal$rid
}
res <- opal.post(opal, "r", "session", opal$rid, "workspaces", query=list(save=saveId))
invisible(saveId)
}
}
#' Restore a R workspace from a opal.
#'
#' @family workspace functions
#' @param opal Opal object.
#' @param ws The workspace name
#' @examples
#' \dontrun{
#' o <- opal.login('administrator','password', url='https://opal-demo.obiba.org')
#' opal.workspace_restore(o, 'test')
#' opal.logout(o)
#' }
#' @export
opal.workspace_restore <- function(opal, ws) {
if (!is.na(opal$version) && opal.version_compare(opal,"4.5")<0) {
warning("Workspace restore is not available for opal ", opal$version, " (4.5.0 or higher is required)")
} else {
if (length(ws) == 0) {
stop("Workspace name is missing or empty.")
}
ignore <- opal.put(opal, "r", "session", opal$rid, "workspace", ws)
}
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.