Merge pull request #41 from SASPAC/dev

The BasePlus package [ver. 1.43.0]

README.md

@@ -54,7 +54,7 @@ libname NEW "%workPath()/new";
 ```
 and more.
 
-SHA256 digest for the latest version of `BasePlus`: F*BD0333B92D7CB639A136CD4994DE0C63F8396E449E45BC714D71D2E15318F42D
+SHA256 digest for the latest version of `BasePlus`: F*68BB953CD732EB43119A3339656670292317FE1C3B764EC57484C7D5C9DF23EB
 
 [**Documentation for BasePlus**](./baseplus.md "Documentation for BasePlus")
 

baseplus.md

@@ -9,22 +9,22 @@
 ### Version information:
   
 - Package: BasePlus
-- Version: 1.40.0
-- Generated: 2024-06-06T21:47:12
+- Version: 1.43.0
+- Generated: 2024-07-22T08:50:35
 - Author(s): Bartosz Jablonski (yabwon@gmail.com), Quentin McMullen (qmcmullen@gmail.com)
 - Maintainer(s): Bartosz Jablonski (yabwon@gmail.com)
 - License: MIT
-- File SHA256: `F*BD0333B92D7CB639A136CD4994DE0C63F8396E449E45BC714D71D2E15318F42D` for this version
-- Content SHA256: `C*A35E716739EC4FF9767C363E840458FB7D5212605982276632F59FD26AB43594` for this version
+- File SHA256: `F*68BB953CD732EB43119A3339656670292317FE1C3B764EC57484C7D5C9DF23EB` for this version
+- Content SHA256: `C*7436BD6446CDA2F57163B7BA45482750D460CA9AEFDCA4012253D742B8EE5E65` for this version
   
 ---
  
-# The `BasePlus` package, version: `1.40.0`;
+# The `BasePlus` package, version: `1.43.0`;
   
 ---
  
 
-# The BasePlus package [ver. 1.40.0] <a name="baseplus-package"></a> ###############################################
+# The BasePlus package [ver. 1.43.0] <a name="baseplus-package"></a> ###############################################
 
 The **BasePlus** package implements useful
 functions and functionalities I miss in the BASE SAS.
@@ -384,12 +384,13 @@ localization (only if additional content was deployed during the installation pr
  
 --------------------------------------------------------------------
  
-*SAS package generated by SAS Package Framework, version `20240529`*
+*SAS package generated by SAS Package Framework, version `20240711`*
  
 --------------------------------------------------------------------
  
 # The `BasePlus` package content
 The `BasePlus` package consists of the following content:
+ 
 1. [`%bppipe()` macro ](#bppipe-macro-1 )
 2. [`%deduplistc()` macro ](#deduplistc-macro-2 )
 3. [`%deduplistp()` macro ](#deduplistp-macro-3 )
@@ -453,20 +454,23 @@ The `BasePlus` package consists of the following content:
 61. [`%filepath()` macro ](#filepath-macro-61 )
 62. [`%finddswithvarval()` macro ](#finddswithvarval-macro-62 )
 63. [`%fmt()` macro ](#fmt-macro-63 )
-64. [`%gettitle()` macro ](#gettitle-macro-64 )
-65. [`%iffunc()` macro ](#iffunc-macro-65 )
-66. [`%infmt()` macro ](#infmt-macro-66 )
-67. [`%letters()` macro ](#letters-macro-67 )
-68. [`%libpath()` macro ](#libpath-macro-68 )
-69. [`%minclude()` macro ](#minclude-macro-69 )
-70. [`%monthshift()` macro ](#monthshift-macro-70 )
-71. [`%replist()` macro ](#replist-macro-71 )
-72. [`%time()` macro ](#time-macro-72 )
-73. [`%today()` macro ](#today-macro-73 )
-74. [`%translate()` macro ](#translate-macro-74 )
-75. [`%tranwrd()` macro ](#tranwrd-macro-75 )
-76. [`%workpath()` macro ](#workpath-macro-76 )
-77. [License note](#license)
+64. [`%generateoneliners()` macro ](#generateoneliners-macro-64 )
+65. [`%gettitle()` macro ](#gettitle-macro-65 )
+66. [`%iffunc()` macro ](#iffunc-macro-66 )
+67. [`%infmt()` macro ](#infmt-macro-67 )
+68. [`%letters()` macro ](#letters-macro-68 )
+69. [`%libpath()` macro ](#libpath-macro-69 )
+70. [`%minclude()` macro ](#minclude-macro-70 )
+71. [`%monthshift()` macro ](#monthshift-macro-71 )
+72. [`%replist()` macro ](#replist-macro-72 )
+73. [`%time()` macro ](#time-macro-73 )
+74. [`%today()` macro ](#today-macro-74 )
+75. [`%translate()` macro ](#translate-macro-75 )
+76. [`%tranwrd()` macro ](#tranwrd-macro-76 )
+77. [`%workpath()` macro ](#workpath-macro-77 )
+  
+ 
+78. [License note](#license)
   
 ---
  
@@ -975,6 +979,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
  <,varRange=>
  <,quote=>
  <,mcArray=> 
+ <,ignoreCases>
 )
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -987,7 +992,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
                        a variables separator on the created list. 
 
 * `pattern = .*`     - *Optional*, default value `.*` (i.e. any text), 
-                       a variable name regexp pattern, case INSENSITIVE! 
+                       a variable name regexp pattern, by default case INSENSITIVE! 
 
 * `varRange = _all_` - *Optional*, default value `_all_`, 
                        a named range list of variables. 
@@ -1008,6 +1013,8 @@ The basic syntax is the following, the `<...>` means optional parameters:
                            `%put %getVars(..., mcArray=XXX);` will result with  
                           an Explicit & Radical Refuse Of Run (aka ERROR).
 
+* `ignoreCases=`     - *Optional*, default value is 1.  
+                        Indicates if search should be case insensitive.
 
  
 ### EXAMPLES AND USECASES: ####################################################
@@ -1874,7 +1881,8 @@ The basic syntax is the following, the `<...>` means optional parameters:
  <,sep=>
  <,pattern=>
  <,varRange=>
- <,quote=>          
+ <,quote=>
+ <,ignoreCases=> 
 )
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -1895,6 +1903,9 @@ The basic syntax is the following, the `<...>` means optional parameters:
 * `quote =`          - *Optional*, default value is blank, a quotation 
                        symbol to be used around values.
 
+* `ignoreCases=`     - *Optional*, default value is 1.  
+                        Indicates if search should be case insensitive.
+
  
 ### EXAMPLES AND USECASES: ####################################################
 
@@ -2018,6 +2029,9 @@ The basic syntax is the following, the `<...>` means optional parameters:
  <,boxPlotSymbolSize=>
  <,boxPlotLineSize=>
  <,boxPlotFill=>
+ <,meanShiftLine=>
+ <,meanShiftStep=>
+ <,meanShiftColors=>
  <,colorsList=>
  <,monochrome=>
  <,antialiasMax=>
@@ -2039,9 +2053,15 @@ The basic syntax is the following, the `<...>` means optional parameters:
  <,catAxisValueAttrs=>
  <,xaxisValueAttrs=>
  <,xaxisTickstyle=>
+ <,xaxisValues=>
+ <,xaxisValuesDisplay=>
+ <,xaxisValuesFormat=>
+ <,xaxisValuesRotate=>
+ <,xaxisOther=>
  <,sganno=>
  <,odsGraphicsOptions=>
  <,sgPlotOptions=>
+ <,vertical=>
 
  <,VSCALE=>
  <,KERNEL_K=>
@@ -2052,6 +2072,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
 
  <,cleanTempData=>
  <,codePreview=>
+ <,reuseN=>
 )
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -2103,6 +2124,17 @@ The basic syntax is the following, the `<...>` means optional parameters:
                          Transparency of the box plot.
                          Ranges from 0.0 (opaque) to 1.0 (full translucent).
 
+* `meanShiftLine`      - *Optional*, default value `0`.
+                         Indicates if a line connecting mean symbol 
+                         on the Box Plot should be added.
+
+* `meanShiftStep`      - *Optional*, default value `0.1`.
+                         Sets how smooth gradient should be
+                         on the "mean-shift" line.
+
+* `meanShiftColors`    - *Optional*, default value is empty.
+                         List of colours for plotting the "mean-shift" line.
+                         Empty indicates that the `colorsList` value will be used.
 
 * `colorsList`         - *Optional*, default value is empty.
                          List of colours for plotting.
@@ -2134,7 +2166,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
                          For details see notes below.
 
 * `xBothAxis`          - *Optional*, default value is `1`. 
-                         Indicates if both (top and bootom) axis (horizontal) should be printed.
+                         Indicates if both (top and bottom) axis (horizontal) should be printed.
                          If not `1` then only bottom axis is displayed.
 
 * `catLabelPos`        - *Optional*, default value `DATACENTER`.
@@ -2183,11 +2215,34 @@ The basic syntax is the following, the `<...>` means optional parameters:
                          Allowed values are `OUTSIDE`, `INSIDE`, `ACROSS`, and `INBETWEEN`. 
                          *For SAS previous to* **9.4M5** *set to missing!*
 
+* `xaxisValues`        - *Optional*, default value is empty.
+                         It is a wrapper to provide value for 
+                         the `XAXIS` statement, for `Values` option.
+
+* `xaxisValuesDisplay` - *Optional*, default value is empty.
+                         It is a wrapper to provide value for 
+                         the `XAXIS` statement, for `ValuesDisplay` option.
+
+* `xaxisValuesFormat`  - *Optional*, default value is empty.
+                         It is a wrapper to provide value for 
+                         the `XAXIS` statement, for `ValuesFormat` option.
+                         Instead using `w.d` format, use its alias `Fw.d`.
+
+* `xaxisValuesRotate`  - *Optional*, default value is empty.
+                         It is a wrapper to provide value for 
+                         the `XAXIS` statement, for `ValuesRotate` option.
+
+* `xaxisOther`         - *Optional*, default value is empty.
+                         It is a wrapper to provide value for 
+                         the `XAXIS` statement options not mentioned above.
+                         You can use it to provide, e.g., `GRID`, 'MINOR',
+                         `MINORGRID`, `GRIDATTRS=`, or `MINORGRIDATTRS=`.
+
 * `sganno`             - *Optional*, default value is empty.
                          keeps name of a data set for the `sganno=` option
                          of the SGPLOT procedure.
 
-* `sgPlotOptions`      - *Optional*, default value is `noautolegend noborder`.
+* `sgPlotOptions`      - *Optional*, default value is `noautolegend noborder subpixel`.
                          List of additional options values for SGPLOT procedure.
 
 * `odsGraphicsOptions` - *Optional*, default value is empty.
@@ -2243,6 +2298,11 @@ The basic syntax is the following, the `<...>` means optional parameters:
 * `codePreview`        - *Optional*, default value `0`.
                          Indicates if source code should be MPRINTed to log.
 
+* `reuseN`             - *Optional*, default value `6`.
+                         Indicates how many times colours list should be repeated
+                         so that colours could be reused in case the number of groups
+                         is greater than the colours list length.
+
 ---
 
 ### NOTES: ###################################################################
@@ -5802,7 +5862,125 @@ The basic syntax is the following, the `<...>` means optional parameters:
   
 ---
  
-## `%gettitle()` macro <a name="gettitle-macro-64"></a> ######
+## `%generateoneliners()` macro <a name="generateoneliners-macro-64"></a> ######
+ 
+## >>> `%GenerateOneLiners()` macro: <<< <a name="generateoneliners-macro"></a> #######################  
+
+The `%GenerateOneLiners()` macro is a "macro-generator" dedicated 
+to "lazy typers".
+
+It allows to generate macro wrappers for functions 
+that have the following form:
+
+~~~~~~~~~~~~~~~~~~~~~~~sas
+%macro FUNCTION()/parmbuff;
+%sysfunc(FUNCTION&syspbuff)
+%mend FUNCTION;
+
+%macro qFUNCTION()/parmbuff;
+%qsysfunc(FUNCTION&syspbuff)
+%mend qFUNCTION;
+~~~~~~~~~~~~~~~~~~~~~~~
+
+See examples below for the details.
+
+The `%GenerateOneLiners()` macro is not pure macro code.
+
+### SYNTAX: ###################################################################
+
+The basic syntax is the following, the `<...>` means optional parameters:
+~~~~~~~~~~~~~~~~~~~~~~~sas
+%GenerateOneLiners(
+  <,listOfFunctions=>
+  <,prefix=>
+)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+**Arguments description**:
+
+1. `listOfFunctions`  - *Required*, is a space separated list of 
+                         valid SAS functions. Default value is:
+                         `CATX CATQ CATT CAT COMPRESS REVERSE REPEAT`.
+
+2. `prefix`           - *Optional*, a prefix added to the name 
+                         of a created macro.
+
+---
+
+ 
+### EXAMPLES AND USECASES: ####################################################
+
+**EXAMPLE 1.** Create list of macrofunctions for
+               `CATX CATQ CATT CAT COMPRESS REVERSE REPEAT`:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
+%GenerateOneLiners(prefix=_)
+
+%let a = 1,2,3,4,5,6;
+%put %_CATX(%str( ),&a.);
+%put %_CATQ(2A,&a.);
+%put %_QCATQ(1AMD,%str(,),&a.);
+
+%let x=a 1 b 2 c 3 d 4 e 5 f 6 g;
+%put %_COMPRESS(&x.);
+%put %_COMPRESS(&x.,,ka);
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**EXAMPLE 2.** Create list of macrofunctions for
+               `SUM MEAN MEDIAN VAR STD USS CSS RANGE IQR MAD SUMABS`:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
+%GenerateOneLiners(
+  listOfFunctions=SUM MEAN MEDIAN VAR STD USS CSS RANGE IQR MAD SUMABS
+, prefix=_)
+
+%put 
+%_SUM(1,2,3,4,5,6) 
+%_MEAN(1,2,3,4,5,6)
+%_MEDIAN(1,2,3,4,5,6)
+%_VAR(1,2,3,4,5,6)
+;
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**EXAMPLE 3.** Some other lists:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
+%GenerateOneLiners(prefix=_
+, listOfFunctions=CDF PDF RAND QUANTILE SQUANTILE SDF logCDF logPDF logSDF RMS
+)
+
+%GenerateOneLiners(prefix=_
+, listOfFunctions=YEAR QTR MONTH WEEK DAY HOUR MINUTE SECOND
+)
+
+%GenerateOneLiners(prefix=_
+, listOfFunctions=PCTL1 PCTL2 PCTL3 PCTL4 PCTL5 PCTL
+)
+
+%GenerateOneLiners(prefix=_
+, listOfFunctions=YYQ MDY HMS INTCK INTNX SLEEP
+)
+
+%GenerateOneLiners(prefix=_
+, listOfFunctions=WHICHC WHICHN 
+)
+
+%GenerateOneLiners(prefix=_
+, listOfFunctions=SYMEXIST SYMGLOBL SYMLOCAL 
+)
+ 
+%GenerateOneLiners(prefix=_
+, listOfFunctions=PRXCHANGE PRXMATCH PRXPAREN PRXPARSE
+)
+ 
+%GenerateOneLiners(prefix=_
+, listOfFunctions=MD5 SHA256 HASHING
+)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+---
+
+  
+---
+ 
+## `%gettitle()` macro <a name="gettitle-macro-65"></a> ######
  
 ## >>> `%getTitle()` macro: <<< <a name="gettitle-macro"></a> #######################  
 
@@ -5888,7 +6066,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
   
 ---
  
-## `%iffunc()` macro <a name="iffunc-macro-65"></a> ######
+## `%iffunc()` macro <a name="iffunc-macro-66"></a> ######
  
 ## >>> `%iffunc()` macro: <<< <a name="iffunc-macro"></a> #######################  
 
@@ -6089,7 +6267,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
   
 ---
  
-## `%infmt()` macro <a name="infmt-macro-66"></a> ######
+## `%infmt()` macro <a name="infmt-macro-67"></a> ######
  
 ## >>> `%infmt()` macro: <<< <a name="infmt-macro"></a> #######################  
 
@@ -6146,7 +6324,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
   
 ---
  
-## `%letters()` macro <a name="letters-macro-67"></a> ######
+## `%letters()` macro <a name="letters-macro-68"></a> ######
  
 ## >>> `%letters()` macro: <<< <a name="letters-macro"></a> #######################  
 
@@ -6264,7 +6442,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
   
 ---
  
-## `%libpath()` macro <a name="libpath-macro-68"></a> ######
+## `%libpath()` macro <a name="libpath-macro-69"></a> ######
  
 ## >>> `%libPath()` macro: <<< <a name="libpath-macro"></a> #######################  
 
@@ -6309,7 +6487,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
   
 ---
  
-## `%minclude()` macro <a name="minclude-macro-69"></a> ######
+## `%minclude()` macro <a name="minclude-macro-70"></a> ######
  
 ## >>> `%mInclude()` macro: <<< <a name="minclude-macro"></a> #######################  
 
@@ -6522,7 +6700,7 @@ quit;
   
 ---
  
-## `%monthshift()` macro <a name="monthshift-macro-70"></a> ######
+## `%monthshift()` macro <a name="monthshift-macro-71"></a> ######
  
 ## >>> `%monthShift()` macro: <<< <a name="monthshift-macro"></a> #######################  
 
@@ -6671,7 +6849,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
   
 ---
  
-## `%replist()` macro <a name="replist-macro-71"></a> ######
+## `%replist()` macro <a name="replist-macro-72"></a> ######
 
 ## >>> `%repList()` macro: <<< <a name="replist-macro"></a> #######################
 
@@ -6787,7 +6965,7 @@ run;
   
 ---
  
-## `%time()` macro <a name="time-macro-72"></a> ######
+## `%time()` macro <a name="time-macro-73"></a> ######
  
 ## >>> `%time()` macro: <<< <a name="time-macro"></a> #######################  
 
@@ -6830,7 +7008,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
   
 ---
  
-## `%today()` macro <a name="today-macro-73"></a> ######
+## `%today()` macro <a name="today-macro-74"></a> ######
  
 ## >>> `%today()` macro: <<< <a name="today-macro"></a> #######################  
 
@@ -6873,7 +7051,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
   
 ---
  
-## `%translate()` macro <a name="translate-macro-74"></a> ######
+## `%translate()` macro <a name="translate-macro-75"></a> ######
  
 ## >>> `%translate()` macro: <<< <a name="translate-macro"></a> #######################  
 
@@ -6937,7 +7115,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
   
 ---
  
-## `%tranwrd()` macro <a name="tranwrd-macro-75"></a> ######
+## `%tranwrd()` macro <a name="tranwrd-macro-76"></a> ######
  
 ## >>> `%tranwrd()` macro: <<< <a name="tranwrd-macro"></a> #######################  
 
@@ -7004,7 +7182,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
   
 ---
  
-## `%workpath()` macro <a name="workpath-macro-76"></a> ######
+## `%workpath()` macro <a name="workpath-macro-77"></a> ######
  
 ## >>> `%workPath()` macro: <<< <a name="workpath-macro"></a> #######################