R/globals.R

In cloudyr/bigQueryR: Interface with Google BigQuery with Shiny Compatibility

## store project name
.bqr_env <- new.env(parent = emptyenv())

#' Set global project name
#'
#' Set a project name used for this R session
#'
#' @param project project name you want this session to use by default, or a project object
#'
#' @details
#'   This sets a project to a global environment value so you don't need to
#' supply the project argument to other API calls.
#'
#' @return The project name (invisibly)
#'
#' @family project functions
#' @import assertthat
#' @export
bqr_global_project <- function(project){

  assert_that(is.string(project))
  
  .bqr_env$project <- project
  message("Set default project to '", project,"'")
  return(invisible(.bqr_env$project))
  
}

#' @rdname bqr_global_project
#' @inheritParams bqr_global_project
#' @export
bq_global_project <- function(project){
  .Deprecated("bqr_global_project")
  bqr_global_project(project)
}

#' Get global project name
#'
#' project name set this session to use by default
#'
#' @return project name
#'
#' @details
#'   Set the project name via \link{bq_global_project}
#'
#' @family project functions
#' @export
bqr_get_global_project <- function(){

  if(!exists("project", envir = .bqr_env)){
    stop("Project is NULL and couldn't find global project ID name.
         Set it via bq_global_project")
  }
  
  .bqr_env$project
  
}

#' @rdname bqr_get_global_project
#' @export
bq_get_global_project <- function(){
  .Deprecated("bqr_get_global_project")
  bqr_get_global_project()
}

#' Set global dataset name
#'
#' Set a dataset name used for this R session
#'
#' @param dataset dataset name you want this session to use by default, or a dataset object
#'
#' @details
#'   This sets a dataset to a global environment value so you don't need to
#' supply the dataset argument to other API calls.
#'
#' @return The dataset name (invisibly)
#'
#' @family dataset functions
#' @export
#' @import assertthat
bqr_global_dataset <- function(dataset){

  assert_that(is.string(dataset))
  
  .bqr_env$dataset <- dataset
  message("Set default dataset to '", dataset,"'")
  return(invisible(.bqr_env$dataset))
  
}

#' @rdname bqr_global_dataset
#' @inheritParams bqr_global_dataset
#' @export
bq_global_dataset <- function(dataset){
  .Deprecated("bqr_global_dataset")
  bqr_global_dataset(dataset)
}

#' Get global dataset name
#'
#' dataset name set this session to use by default
#'
#' @return dataset name
#'
#' @details
#'   Set the dataset name via \link{bq_global_dataset}
#'
#' @family dataset functions
#' @export
bqr_get_global_dataset <- function(){

  if(!exists("dataset", envir = .bqr_env)){
    stop("dataset is NULL and couldn't find global dataset ID name.
         Set it via bq_global_dataset")
  }
  
  .bqr_env$dataset
  
}

#' @rdname bqr_get_global_dataset
#' @export
bq_get_global_dataset <- function(){
  .Deprecated("bqr_get_global_dataset")
  bqr_get_global_dataset()
}