R/run_sas.R

In sasr: 'SAS' Interface

#' Run SAS code with SAS Session
#'
#' @description `r lifecycle::badge("experimental")`
#' Run SAS code with a SAS session.
#'
#' @param sas_code (`character`)\cr sas code to be executed.
#' @param results (`character`)\cr sas code execution results type.
#' @param sas_session (`saspy.sasbase.SASsession`) SAS session.
#'
#' @return Named list with following elements:
#' - `LOG`: `string` of SAS execution log.
#' - `LST`: `string` of SAS execution result, in html or txt format.
#'
#' @export
#' @details `run_sas` will run sas code through SAS session.
#' The results is a named list of `LST` and `LOG`.
#' The result part will be stored in `LST`, and log will be stored in `LOG`.
#' If `results` argument is "TEXT", then results are in text format;
#' if `results` argument is "HTML", then results are in html format.
#'
run_sas <- function(sas_code, results = c("TEXT", "HTML"), sas_session = get_sas_session()) {
  assert_string(sas_code)
  results <- match.arg(results)
  sas_session$submit(code = sas_code, results = results)
}
#' Transfer data.frame to SAS
#'
#' @description `r lifecycle::badge("experimental")`
#' Transfer `data.frame` object from R environment to SAS.
#'
#' @param df (`data.frame`)\cr data frame to be transferred.
#' @param table (`character`)\cr table name in SAS.
#' @param libref (`character`)\cr library name in SAS.
#' @param sas_session (`saspy.sasbase.SASsession`) SAS session.
#' @param ... additional arguments for `saspy.sasbase.SASsession.df2sd`
#'
#' @return "saspy.sasdata.SASdata" object.
#' @export
df2sd <- function(df, table = "_df", libref = "", ..., sas_session = get_sas_session()) {
  df <- validate_data(df)
  sas_session$df2sd(df, table = table, libref = libref, ...)
}

#' Transfer SAS Data to R
#'
#' @description `r lifecycle::badge("experimental")`
#' Transfer the table in SAS session to R.
#'
#' @param table (`character`)\cr table name in SAS.
#' @param libref (`character`)\cr library name in SAS.
#' @param sas_session (`saspy.sasbase.SASsession`) SAS session.
#' @param ... additional arguments for `saspy.sasbase.SASsession.sd2df`
#'
#' @return `data.frame` object.
#' @export
sd2df <- function(table, libref = "", ..., sas_session = get_sas_session()) {
  sas_session$sd2df(table = table, libref = libref, ...)
}