R/get-session.R

In sasquatch: Use 'SAS', R, and 'quarto' Together

#' Get current SAS session
#'
#' Returns the current SAS session, which can be used to extend `sasquatch`
#' functionality or access the current session within Python.
#'
#' @return `saspy.sasbase.SASsession`; Current SAS session.
#'
#' @details
#' ## Extending `sasquatch` functionality
#' `SASPy` has a wealth of functionality, some of which have not all been
#' implemented within `sasquatch`. `sas_get_session()` offers a gateway to
#' unimplemented functionality within the
#' [SASsession class](https://sassoftware.github.io/saspy/api.html#sas-session-object).
#'
#' ## Using Python
#' When utilizing Python, R, and SAS, start the session within R using
#' `sas_connect()` and utilize `reticulate` to pass the
#' `saspy.sasbase.SASsession` object to Python.
#'
#' @export
#'
#' @family session management functions
#' @examplesIf interactive()
#' sas_connect()
#'
#' sas_get_session()
sas_get_session <- function() {
  .pkgenv$session
}