[skip vbump] prepare for CRAN release (#32)

close #31 
update for cran release

---------

Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>

DESCRIPTION

@@ -1,17 +1,17 @@
 Type: Package
 Package: sasr
-Title: SAS Interface in R
-Version: 0.1.1
+Title: 'SAS' Interface
+Version: 0.1.2
 Date: 2023-04-26
 Authors@R: c(
     person("Liming", "Li", , "liming.li@roche.com", role = c("aut", "cre")),
     person("Daniel", "Sabanes Bove", , "daniel.sabanes_bove@roche.com", role = c("aut")),
     person("Isaac", "Gravestock", , "isaac.gravestock@roche.com", role = c("aut")),
     person("F. Hoffmann-La Roche AG", role = c("cph", "fnd"))
   )
-Description: Provides a SAS interface in R, through 'SASpy'(<https://sassoftware.github.io/saspy/>) and 'reticulate'(<https://rstudio.github.io/reticulate/>).
-  This package helps you create SAS sessions, execute SAS code in remote SAS servers, retrieve execution results and log, and exchange datasets between SAS and R.
-  It also helps you to install 'SASpy' and create a configuration file for the connection. Please review the 'SASpy' license file as instructed so that you comply with its separate and independent license.
+Description: Provides a 'SAS' interface, through 'SASPy'(<https://sassoftware.github.io/saspy/>) and 'reticulate'(<https://rstudio.github.io/reticulate/>).
+  This package helps you create 'SAS' sessions, execute 'SAS' code in remote 'SAS' servers, retrieve execution results and log, and exchange datasets between 'SAS' and 'R'.
+  It also helps you to install 'SASPy' and create a configuration file for the connection. Please review the 'SASPy' license file as instructed so that you comply with its separate and independent license.
 License: Apache License 2.0
 URL: https://github.com/insightsengineering/sasr/
 BugReports: https://github.com/insightsengineering/sasr/issues

NEWS.md

@@ -1,4 +1,4 @@
-# sasr 0.1.1
+# sasr 0.1.2
 
 * First CRAN version of the package.
 * The package facilitates the execution of SAS code from R.

R/sascfg.R

@@ -12,6 +12,8 @@
 #' @param sascfg (`character`)\cr target file of configuration.
 #' @param options (`list`)\cr additional list of arguments to pass to `ssh` command.
 #'
+#' @return No return value.
+#'
 #' @export
 #' @details
 #' `host` and `saspath` are required to connect to remote SAS server. Other arguments can follow default.
@@ -27,4 +29,5 @@ sascfg <- function(name = "default", host, saspath, ssh = system("which ssh", in
   writeLines(sprintf("SAS_config_names=['%s']", name), con = f)
   writeLines(sprintf("%s=%s", name, toString(r_to_py(lst))), f)
   close(f)
+  invisible()
 }

R/utils.R

@@ -6,6 +6,7 @@
 #' @param method (`character`)\cr method to install `saspy`.
 #' @param conda (`character`)\cr path to `conda` executable.
 #'
+#' @return No return value.
 #' @export
 install_saspy <- function(method = "auto", conda = "auto") {
   msg <- paste0(
@@ -114,6 +115,7 @@ validate_sascfg <- function(sascfg) {
 #' @details this function is designed to facilitate the R users programming practice
 #' of function oriented programming instead of object oriented programmings.
 #'
+#' @return A new SAS session if there are no previous SAS session, or the last SAS session created.
 #' @export
 get_sas_session <- function() {
   if (is.null(.sasr_env$.sas_session)) {
@@ -139,6 +141,7 @@ get_sas_session <- function() {
 #'
 #' @param sascfg (`character`)\cr SAS session configuration.
 #'
+#' @return SAS session.
 #' @export
 sas_session_ssh <- function(sascfg = get_sas_cfg()) {
   validate_sascfg(sascfg)
@@ -156,6 +159,8 @@ sas_session_ssh <- function(sascfg = get_sas_cfg()) {
 #' the `sascfg_personal.py` file under current directory. If it does not exist, it will
 #' search this file under home directory. If this file does not exist, NULL will be returned.
 #'
+#' @return The file path of default SAS configuration file, or NULL if not found.
+#'
 #' @export
 get_sas_cfg <- function() {
   default_cfg <- getOption("sascfg", "sascfg_personal.py")

inst/WORDLIST

@@ -3,7 +3,7 @@ Hoffmann
 LST
 Reticulate
 SASdata
-SASpy
+SASPy
 Sabanes
 Viya
 funder