Package 'sasquatch'

Description

Adds sascfg_personal.py and authinfo files and prefills relevant info according to a specified template.

Usage

configure_saspy(template = c("none", "oda"), overwrite = FALSE)

Arguments

Details

Configuration for SAS can vary greatly based on your computer's operating system and the SAS platform you wish to connect to (see vignette("configuration") for more information).

Regardless of your desired configuration, configuration always starts with the creation of a sascfg_personal.py file within the SASPy package installation. This will look like:

SAS_config_names = ['config_name']

config_name = {

}

SAS_config_names should contain a string list of the variable names of all configurations. Configurations are specified as dictionaries, and configuration parameters depend on the access method.

Additionally, some access methods will require an additional authentication file (.authinfo for Linux and Mac, ⁠_authinfo⁠ for Windows) stored in the user's home directory, which are constructed as follows:

config_name user {your username} password {your password}

Templates

The "none" template simply creates a sascfg_personal.py file within the SASPy package installation.

The "oda" template will set up a configuration for SAS On Demand for Academics. The sascfg_personal.py and authinfo files will be automatically configured using the information you provide through prompts.

Value

No return value.

See Also

install_saspy()

Examples

# set up an ODA connection
config_saspy(template = "oda")

Description

Installs the SASPy package and its dependencies within a virtual Python environment.

Behavior was derived from tensorflow::install_tensorflow().

Usage

install_saspy(
  method = c("auto", "virtualenv", "conda"),
  conda = "auto",
  envname = "r-saspy",
  extra_packages = NULL,
  restart_session = TRUE,
  conda_python_version = NULL,
  ...,
  pip_ignore_installed = FALSE,
  new_env = identical(envname, "r-saspy"),
  python_version = NULL
)

Arguments

Value

No return value.

See Also

configure_saspy()

Examples

install_saspy(
  envname = "new-sasquatch-env",
  extra_packages = c("matplotlib", "numpy"),
)

Description

Starts a SAS session. This is required before doing anything!

Usage

sas_connect(cfgname, reconnect = FALSE)

Arguments

Details

All configurations are specified within the sascfg_personal.py file inside the SASPy package. For more information about SASPy configuration, check out the configuration documentation or vignette("configuration").

Value

No return value.

See Also

Other session management functions: sas_disconnect(), sas_get_session()

Examples

sas_connect(cfgname = "oda")

Description

Disconnects from the current SAS session.

Usage

sas_disconnect()

Value

No return value.

See Also

Other session management functions: sas_connect(), sas_get_session()

Examples

sas_connect()

sas_disconnect()

Description

Produces HTML or latex output for rending within quarto or rmarkdown documents.

Usage

sas_engine(options)

Arguments

Details

Will be activated by running library(sasquatch)

Supported knitr chunk options

sasquatch's engine implements may of the same options as the R engine in knitr, but not all.

• eval (Default: TRUE): Evaluate the code chunk (if false, just echos the code into the output)

• echo (Default: TRUE): Include the source code in output

• output (Default: TRUE): Include the results of executing the code in the output (TRUE or FALSE).

• include (Default: TRUE): Include any output (code or results).

• capture (Only within HTML; Default: "both"): If "both", tabpanel with output and log included. If "listing", only output is included. If "log" only log is included.

• out.width (Only within HTML; Default: "auto"): Width of output.

• out.height (Only within HTML; Default: "auto"): Height of output.

Value

knitr engine output.

Examples

# The below function is run internally within `sasquatch` on startup
knitr::knit_engines$set(sas = sas_engine)

Description

Copies a file on the remote SAS server. Is analogous to file.copy(), but for the remote SAS server.

Usage

sas_file_copy(from_path, to_path)

Arguments

Value

logical; value indicating if the operation succeeded.

See Also

Other file management functions: sas_file_download(), sas_file_exists(), sas_file_remove(), sas_file_upload(), sas_list()

Examples

# connect to SAS
sas_connect()

# create an example file
local_path <- tempfile(fileext = ".txt")
cat("some example text", file = tempfile_path)

sas_path <- readline(
  "Please provide the full path to upload an example file to (e.g., ~/example.txt)."
)
sas_file_upload(local_path, sas_path)

from_path <- sas_path
to_path <- readline(
  "Please provide the full path to copy the example file to (e.g., ~/example_copy.txt)."
)
sas_file_copy(from_path, to_path)

# cleanup
unlink(local_path)
sas_file_remove(from_path)
sas_file_remove(to_path)

Description

Downloads a file to the remote SAS server.

Usage

sas_file_download(sas_path, local_path)

Arguments

Value

logical; value indicating if the operation succeeded.

See Also

Other file management functions: sas_file_copy(), sas_file_exists(), sas_file_remove(), sas_file_upload(), sas_list()

Examples

# connect to SAS
sas_connect()

# create an example file
local_path <- tempfile(fileext = ".txt")
cat("some example text", file = tempfile_path)

sas_path <- readline(
  "Please provide the full path to upload an example file to (e.g., ~/example.txt)."
)
sas_file_upload(local_path, sas_path)

# download the uploaded file
local_copy_path <- sub("\\.txt$", "_copy.txt", tempfile_path)
sas_file_download(sas_path, local_copy_path)

# cleanup
unlink(local_path)
unlink(local_copy_path)
sas_file_remove(sas_path)

Description

Checks if a file exists on the remote SAS server. Is analogous to file.exists(), but for the remote SAS server.

Usage

sas_file_exists(path)

Arguments

Value

logical; value indicating if the operation succeeded.

See Also

Other file management functions: sas_file_copy(), sas_file_download(), sas_file_remove(), sas_file_upload(), sas_list()

Examples

# connect to SAS
sas_connect()

# create an example file
local_path <- tempfile(fileext = ".txt")
cat("some example text", file = tempfile_path)

sas_path <- readline(
  "Please provide the full path to upload an example file to (e.g., ~/example.txt)."
)
sas_file_upload(local_path, sas_path)

sas_file_exists(sas_path)

# cleanup
unlink(local_path)
sas_file_remove(sas_path)

Description

Deletes a file or directory from the remote SAS server. Is analogous to file.remove(), but for the remote SAS server.

Usage

sas_file_remove(path)

Arguments

Value

logical; value indicating if the operation succeeded.

See Also

Other file management functions: sas_file_copy(), sas_file_download(), sas_file_exists(), sas_file_upload(), sas_list()

Examples

# connect to SAS
sas_connect()

# create an example file
local_path <- tempfile(fileext = ".txt")
cat("some example text", file = tempfile_path)

sas_path <- readline(
  "Please provide the full path to upload an example file to (e.g., ~/example.txt)."
)
sas_file_upload(local_path, sas_path)

sas_file_remove(sas_path)

# cleanup
unlink(local_path)

Description

Uploads a file to the remote SAS server.

Usage

sas_file_upload(local_path, sas_path)

Arguments

Value

logical; value indicating if the operation succeeded.

See Also

Other file management functions: sas_file_copy(), sas_file_download(), sas_file_exists(), sas_file_remove(), sas_list()

Examples

# connect to SAS
sas_connect()

# create an example file
local_path <- tempfile(fileext = ".txt")
cat("some example text", file = tempfile_path)

sas_path <- readline(
  "Please provide the full path to upload an example file to (e.g., ~/example.txt)."
)
sas_file_upload(local_path, sas_path)

# cleanup
unlink(local_path)
sas_file_remove(sas_path)

Description

Converts R table into a table in the current SAS session. R tables must only have logical, integer, double, factor, character, POSIXct, or Date class columns.

Usage

sas_from_r(x, table_name, libref = "WORK", factors_as_strings = TRUE)

Arguments

Details

SAS only has two data types (numeric and character). Data types are converted as follows:

• logical -> numeric

• integer -> numeric

• double -> numeric

• factor -> character

• character -> character

• POSIXct -> numeric (datetime; timezones are lost)

• Date -> numeric (date)

Value

data.frame; x.

See Also

sas_to_r()

Examples

sas_connect()

sas_from_r(mtcars, "mtcars")

Description

Returns the current SAS session, which can be used to extend sasquatch functionality or access the current session within Python.

Usage

sas_get_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.

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.

Value

saspy.sasbase.SASsession; Current SAS session.

See Also

Other session management functions: sas_connect(), sas_disconnect()

Examples

sas_connect()

sas_get_session()

Description

Lists the files or directories of a directory within the remote SAS server.

Usage

sas_list(path)

Arguments

Value

character vector; File or directory names.

See Also

Other file management functions: sas_file_copy(), sas_file_download(), sas_file_exists(), sas_file_remove(), sas_file_upload()

Examples

sas_connect()

sas_list(".")

Description

Execute a SAS file and render html output or save output as html and log.

Usage

sas_run_file(input_path, output_path, overwrite = FALSE)

Arguments

Value

If output_path specified, htmlwidget. Else, no return value.

See Also

Other code execution functions: sas_run_selected(), sas_run_string()

Examples

sas_connect()

tempfile_sas_path <- tempfile(fileext = ".sas")
tempfile_html_path <- sub("\\.sas$", ".html", tempfile_sas_path)
tempfile_log_path <- sub("\\.sas$", ".log", tempfile_sas_path)
cat("PROC MEANS DATA = sashelp.cars;RUN;", file = tempfile_sas_path)
sas_run_file(tempfile_sas_path, tempfile_html_path)

# clean up
unlink(tempfile_sas_path)
unlink(tempfile_html_path)
unlink(tempfile_log_path)

Description

Execute selected SAS code in current session and render html output as SAS widget. See vignette("overview") for more information on how to utilize the addin within RStudio or Positron.

Usage

sas_run_selected()

Value

htmlwidget; HTML5 output.

See Also

Other code execution functions: sas_run_file(), sas_run_string()

Examples

sas_connect()

# highlight something in the active editor of RStudio or Positron

sas_run_selected()

Description

Execute SAS code in current session and render html output.

Usage

sas_run_string(input, capture = "both", height = "auto", width = "auto")

Arguments

Value

htmlwidget; HTML5 output.

See Also

Other code execution functions: sas_run_file(), sas_run_selected()

Examples

sas_connect()

sas_run_string("PROC MEANS DATA = sashelp.cars;RUN;")

Description

Converts table from current SAS session into a R data.frame.

Usage

sas_to_r(table_name, libref = "WORK")

Arguments

Details

SAS only has two data types (numeric and character). Data types are converted as follows:

• numeric -> double

• character -> character

• numeric (datetime, timezones are lost) -> POSIXct

• numeric (date) -> POSIXct

In the conversion process dates and datetimes are converted to local time. If utilizing another timezone, use ⁠attr(date, "tzone") <-⁠ or lubridate::with_tz() to convert back to the desired time zone.

Value

data.frame of the specified SAS table.

See Also

sas_from_r()

Examples

sas_connect()

cars <- sas_to_r("cars", "sashelp")