Merge pull request #46 from SASPAC/dev

The BasePlus package [ver. 2.1.0]

README.md

@@ -53,12 +53,10 @@ libname NEW "%workPath()/new";
 %put %monthShift(2023,1,-5);
 
 %put #%expandDataSetsList(lib=sashelp,datasets=_all_)#;
-
-%workLib(ABC)
 ```
 and more.
 
-SHA256 digest for the latest version of `BasePlus`: F*6394CE27FBCF48D475F682CBCF8CA8B4FDD6D40D2672EF571F4A561BDDF274A6
+SHA256 digest for the latest version of `BasePlus`: F*DFA83F8E0D7424DEB63D49620392068BC68D766552E2804CB6B01DE8E5A87769
 
 [**Documentation for BasePlus**](./baseplus.md "Documentation for BasePlus")
 

baseplus.md

@@ -9,22 +9,22 @@
 ### Version information:
   
 - Package: BasePlus
-- Version: 3.1.1
-- Generated: 2025-11-05T15:10:31
-- Author(s): Bartosz Jablonski (yabwon@gmail.com), contributors are Quentin McMullen (qmcmullen@gmail.com) and Ryo Nakaya (nakaya.ryou@gmail.com)
+- Version: 2.1.0
+- Generated: 2024-09-09T12:55:04
+- Author(s): Bartosz Jablonski (yabwon@gmail.com), Quentin McMullen (qmcmullen@gmail.com)
 - Maintainer(s): Bartosz Jablonski (yabwon@gmail.com)
 - License: MIT
-- File SHA256: `F*6394CE27FBCF48D475F682CBCF8CA8B4FDD6D40D2672EF571F4A561BDDF274A6` for this version
-- Content SHA256: `C*3CA28DF8F3E6D6670D7FD44788D347452F24F4BCF18115873E7EBC742FE30CA4` for this version
+- File SHA256: `F*DFA83F8E0D7424DEB63D49620392068BC68D766552E2804CB6B01DE8E5A87769` for this version
+- Content SHA256: `C*AB16F5B6538515607C3C254E401DC1ACA7293AB36990227F6E7792145CEEAB87` for this version
   
 ---
  
-# The `BasePlus` package, version: `3.1.1`;
+# The `BasePlus` package, version: `2.1.0`;
   
 ---
  
 
-# The BasePlus package [ver. 3.1.1] <a name="baseplus-package"></a> ###############################################
+# The BasePlus package [ver. 2.1.0] <a name="baseplus-package"></a> ###############################################
 
 The **BasePlus** package implements useful
 functions and functionalities I miss in the BASE SAS.
@@ -47,8 +47,7 @@ Kudos to all who inspired me to generate this package:
 *Quentin McMullen*,
 *Kurt Bremser*,
 *Leonid Batkhan*,
-*Louise Hadden*,
-*Ryo Nakaya*.
+*Louise Hadden*.
 
 ---
 
@@ -388,11 +387,6 @@ proc print data=b_x;
 run;
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-**EXAMPLE 29** Create library ABC assigned to `<WORK>/ABC` directory:
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
-  %workLib(abc)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
 ---
   
 ---
@@ -409,7 +403,7 @@ localization (only if additional content was deployed during the installation pr
  
 --------------------------------------------------------------------
  
-*SAS package generated by SAS Package Framework, version `20251017`*
+*SAS package generated by SAS Package Framework, version `20240711`*
  
 --------------------------------------------------------------------
  
@@ -496,11 +490,10 @@ The `BasePlus` package consists of the following content:
 78. [`%translate()` macro ](#translate-macro-78 )
 79. [`%tranwrd()` macro ](#tranwrd-macro-79 )
 80. [`%unifyvarscasesize()` macro ](#unifyvarscasesize-macro-80 )
-81. [`%worklib()` macro ](#worklib-macro-81 )
-82. [`%workpath()` macro ](#workpath-macro-82 )
+81. [`%workpath()` macro ](#workpath-macro-81 )
   
  
-83. [License note](#license)
+82. [License note](#license)
   
 ---
  
@@ -845,7 +838,6 @@ The basic syntax is the following, the `<...>` means optional parameters:
   <,longFormat=>
   <,fileExt=>
   <,maxDepth=>
-  <,backslashSens=>
 )
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -876,11 +868,6 @@ The basic syntax is the following, the `<...>` means optional parameters:
 * `maxDepth=0`                - *Optional*, if not zero then indicates
                                 maximum depth of search in the root path.
 
-* `backslashSens=0`           - *Optional*, if not zero then it indicates 
-                                that backslash(`\`) symbol in files and dirs 
-                                names is detectable under Linux. Accepted 
-                                values: `0` and `1`. Ignored under Windows. 
-
 
 ### EXAMPLES AND USECASES: ####################################################
 
@@ -1002,12 +989,7 @@ The QgetVars() returns quoted value [by %superq()].
 
 See examples below for the details.
 
-When `mcArray=` is not used the `%getVars()` macro executes like 
-a pure macro code. When `mcArray=` is not null (creation of a
-macro variable array is requested) them a single semicolon is returned.
-
-When `validvarname=ANY` in set special care should be kept.
-See dedicated examples below.
+The `%getVars()` macro executes like a pure macro code.
 
 ### SYNTAX: ###################################################################
 
@@ -1021,7 +1003,6 @@ The basic syntax is the following, the `<...>` means optional parameters:
  <,quote=>
  <,mcArray=> 
  <,ignoreCases>
- <,nlit=>
 )
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -1044,32 +1025,23 @@ The basic syntax is the following, the `<...>` means optional parameters:
 
 * `mcArray=`         - *Optional*, default value is blank.
                        1) When *null* - the macro behaves like a macro function 
-                          and ban be used in the `%put` or `%let=` statements.
-                          The returned text is a string with variables list.
-                       2) When *not null* - behavior of the macro is altered.
+                          and returns a text string with variables list.
+                       2) When *not null* - behaviour of the macro is altered.
                           In such case a macro array of selected variables, named 
                           with `mcArray` value as a prefix, is created.
                           Furthermore a macro named as `mcArray` value is generated.
                           (see the macroArray package for the details).
                           When `mcArray=` parameter is active the `getVars` macro 
-                          should not be called within the `%put` or `%let=` statements. 
-                          A single semicolon is produced as the macro result, hence
-                          execution like: `%put %getVars(..., mcArray=XXX) some text;` 
-                          will result with an Explicit & Radical Refuse Of Run (aka ERROR).
+                          cannot be called within the `%put` statement. Execution like: 
+                           `%put %getVars(..., mcArray=XXX);` will result with  
+                          an Explicit & Radical Refuse Of Run (aka ERROR).
 
-* `ignoreCases=`     - *Optional*, default value is 1.
+* `ignoreCases=`     - *Optional*, default value is 1.  
                         Indicates if search should be case insensitive.
 
-* `nlit=`            - *Optional*, default value is 0.
-                        Introduced to improve `validvarname=ANY` handling.
-                        Indicates if the `NLITERAL()` function should be 
-                        executed to cover spacial characters.
-
  
 ### EXAMPLES AND USECASES: ####################################################
 
-**When `validvarname=` option is _not_ `ANY`.** 
-
 **EXAMPLE 1.** A list of all variables from the 
                sashelp.class dataset:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
@@ -1295,44 +1267,6 @@ run;
   %put %do_over(XYZ);
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-**When the `validvarname=ANY` option is set.** 
-
-**EXAMPLE 12.** Get all variables and handle special characters.
-                Without `nlit=1` the code will fail.
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
-  options validvarname = any;
-  data varnameANY;
-    set sashelp.class(obs=3);
-
-    'A&B'n=42;
-    'space name'n=101;
-    '2025-08'n=234;
-    '2025%09'n=235;
-    "2025'10"n=236;
-    '2025"11'n=237;
-  run; 
-
-  %put %getVars(varnameANY, nlit=1);
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-**EXAMPLE 13.** Create macro variable array ABC for all variables.
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
-  %getVars(varnameANY, mcArray=ABC, nlit=1);
-  %put %ABC(1) %ABC(6) %ABC(7) %ABC(11);
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-**EXAMPLE 14.** Get only variables with illegal characters in names.
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
-  %let notV7compliant = %getVars(varnameANY, pattern=[^a-z0-9_], nlit=1);
-  %put &notV7compliant.;
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-
-**EXAMPLE 14.** Print variables starting with a digit.
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
-  %put %getVars(varnameANY, pattern=^\d, nlit=1);
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
 ---
 
   
@@ -1995,11 +1929,6 @@ The basic syntax is the following, the `<...>` means optional parameters:
 * `ignoreCases=`     - *Optional*, default value is 1.  
                         Indicates if search should be case insensitive.
 
-* `nlit=`            - *Optional*, default value is 0.
-                        Introduced to improve `validvarname=ANY` handling.
-                        Indicates if the `NLITERAL()` function should be 
-                        executed to cover spacial characters.
-
  
 ### EXAMPLES AND USECASES: ####################################################
 
@@ -6029,11 +5958,6 @@ See examples below for the details.
 
 The `%findDSwithVarVal()` macro does not execute as a pure macro code.
 
-**NOTE:** 
-When a library is assigned with different engine than:
-"BASE","SPDE","V6","V7","V8","V9","CVP"
-observation number is not returned.
-
 ### SYNTAX: ###################################################################
 
 The basic syntax is the following, the `<...>` means optional parameters:
@@ -6471,7 +6395,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
 
 3. `false` - *Required*, value returned when condition is false.
 
-* `v=`     - *Optional*, v for verbose. If set to `1` extra notes
+4 `v=`     - *Optional*, v for verbose. If set to `1` extra notes
               are printed.
 ---
 
@@ -6668,7 +6592,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
 
 The letters() macro function allows to print a list of Roman
 letters starting from `start` up to `end` incremented by `by`.
-The letters list can be uppercase or lowercase (parameter `c=U` or `c=L`), 
+The letters list can be uppercases or lowercase (parameter `c=U` or `c=L`), 
 can be quoted (e.g. `q=""` or `q=[]`), and can be separated by `s=`.
 
 Values of `start`, `end`, and `by` have to be integers in range between 1 ad 26.
@@ -6696,12 +6620,12 @@ The basic syntax is the following, the `<...>` means optional parameters:
                    Values of `start`, `end`, and `by` are separated by 
                    colon and must be between 1 ad 26.
                    If value is outside range it is set to 
-                   `start=1`, `end=26`, and `by=1`. If `end` is missing
-                   then it is set to value of `start`.
+                   `start=1`, `en=26`, and `by=1`. If `end` is missing
+                   then is set to value of `start`.
                    If `end` is smaller than `start` list is reversed
 
 * `c = U`        - *Optional*, it is a lowercase letters indicator. 
-                   Select `L` or `l`. Default value is `U` for uppercase.
+                   Select `L` or `l`. Default value is `U` for upcase.
 
 * `q = `         - *Optional*, it is a quite around elements of the list. 
                    Default value is empty. Use `%str()` for one quote symbol.
@@ -7631,71 +7555,7 @@ run;
   
 ---
  
-## `%worklib()` macro <a name="worklib-macro-81"></a> ######
-
-## >>> `%workLib()` macro: <<< <a name="worklib-macro"></a> ####################### 
-
-The `%workLib()` macro creates and assigns a WORK-scoped sub-library.
-
-Purpose:
-
-The macro creates (if needed) and assigns a SAS library as a sub-directory 
-under the current `WORK` location. This is useful for isolating temporary 
-outputs per task while ensuring automatic cleanup at the end of the SAS session.
-Basic engines libraries, like `BASE`, `V*`, and simple `SPDE`, can be set.
-
-### SYNTAX: ###################################################################
-
-The basic syntax is the following, the `<...>` means optional parameters:
-~~~~~~~~~~~~~~~~~~~~~~~sas
-%workLib(lib,<engine>)
-~~~~~~~~~~~~~~~~~~~~~~~
-
-**Arguments description**:
- 
-- `lib`    - *Required*: Name of a library (and sub-folder) 
-             to create under WORK. The value must be a valid 
-             nonempty SAS libref (8 characters max, starting 
-             with a letter or underscore).
-
-- `engine` - *Optional*, Name of a basic, directory level, 
-             SAS engine, e.g. `BASE`. When empty the default
-             engine is used.
----
-
-### Details  
-
-- Builds a target path: `<WORK>/<lib>`.
-- All data written to this libref are temporary and will be removed 
-  when the WORK library is cleared at session end.
-- If a directory with the same name already exists under WORK, 
-  the macro prints a note and simply assigns the LIBNAME to 
-  that location.
-- The `dcreate()` function is used to create sub-directory.
-
- 
-### EXAMPLES AND USECASES: ####################################################
-
-**EXAMPLE 1.** Create library ABC assigned to `<WORK>/ABC` directory:
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
-  %workLib(abc)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-**EXAMPLE 2.** Create libraries with different engines:
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
-  %workLib(b,BASE)
-
-  %workLib(v,V6) %* for Windows only.;
-
-  %workLib(s,SPDE)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
----
-
-  
----
- 
-## `%workpath()` macro <a name="workpath-macro-82"></a> ######
+## `%workpath()` macro <a name="workpath-macro-81"></a> ######
  
 ## >>> `%workPath()` macro: <<< <a name="workpath-macro"></a> #######################  
 
@@ -7738,7 +7598,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
  
 # License <a name="license"></a> ######
  
-Copyright (c) 2020 - 2025 Bartosz Jablonski
+Copyright (c) 2020 - 2024 Bartosz Jablonski
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal