R/create_connection.R

Defines functions create_connection

Documented in create_connection

#' Create connection to Connect server
#'
#' The `create_connection()` function is used to create a connection to your
#' Connect server via the **connectapi** package.
#'
#' @param server Connect server address.
#' @param key Administrator API key.
#'
#' @return An RStudio Connect object that can be passed along to methods.
#'
#' @export
create_connection <- function(
    server = Sys.getenv("CONNECT_SERVER"),
    key = Sys.getenv("CONNECT_API_KEY")
) {

  connectapi::connect(server = server, api_key = key)
}
kmasiello/rscview documentation built on Jan. 3, 2023, 2:58 p.m.