R/episphereR.R

In episphere/episphereR: DCEG Data access and manipulation package

#' openURL
#'
#' open a browser window
#' @param url that the browser opens.
#' @return opens a browser window (returns NULL)
#' @examples
#' openURL()
#' openURL("https://www.google.com")
#' @export
openURL <- function(url="https://episphere.github.io/r"){
  utils::browseURL(url)
  invisible()
}

#' opens the box file browser for a directory in your default browser
#' @param id  box folder id.
#' @return opens a browser window (returns NULL)
#' @examples
#' openBoxFolder()
#' openBoxFolder(id=0)
#' @export
openBoxFolder <- function(id=133596945131){
  boxr::box_auth(getOption("episphereR.box_cid"),getOption("episphereR.box_cls"))
  message(paste("folder #",id," opened in your browser",sep=""))
  openURL(paste("https://nih.app.box.com/folder/",id,sep=""))
  invisible()
}

#' openBoxFile
#'
#' opens a box file in your default browser
#' @param id  box file id.
#' @param ver box file version number
#' @return opens a browser window (returns NULL)
#' @export
#' @examples
#' openBoxFile()
#' openBoxFile(id=787813783402)
openBoxFile <- function(id=787813783402,ver=NULL){
  boxr::box_auth(getOption("episphereR.box_cid"),getOption("episphereR.box_cls"))
  url=paste("https://nih.app.box.com/file/",id,sep="")
  if(typeof(NULL)!="NULL"){
    url=paste(url,"?sb=/details/versions/",ver,sep="")
  }
  message(paste("browser tab opened at",url))
  openURL(url)
  invisible()
}

#' boxRead
#'
#' read data from a box file.
#' The function is a wrapper around the box_read function
#' @return an R object
#' @param file_id the file to read (default is a simulated data file)
#' @param version_id the version of the box file
#' @param ... values passed to boxr::box_read
#' @export
#' @examples
#' boxRead(file_id=787813783402)
#' @seealso \code{\link[boxr]{box_read}}
boxRead <- function(file_id=787813783402, version_id = NULL, ...){
  boxr::box_auth(getOption("episphereR.box_cid"),getOption("episphereR.box_cls"))
  boxr::box_read(file_id = file_id, version_id = version_id, ...)
}