Merge pull request #38 from SASPAC/dev

The BasePlus package [ver. 1.41.0]

README.md

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

baseplus.md

@@ -9,22 +9,22 @@
 ### Version information:
   
 - Package: BasePlus
-- Version: 1.39.0
-- Generated: 2024-05-29T16:15:54
+- Version: 1.41.0
+- Generated: 2024-06-09T18:22: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*3C3A2050E3FF46E1FC0F936634A66FC3F294A3531EFE0A7DC9CE74F2EF17C687` for this version
-- Content SHA256: `C*2396916BBB5BC1FA832FB85EDAF14173D528A6C823BA0BACB84FC9E99A8CFC1B` for this version
+- File SHA256: `F*6760DDF382E7CA9A1291F028FA7F2BACB68A3D31CEA3A85104E13EA08645AEF1` for this version
+- Content SHA256: `C*850DEDF85E36C971713B7E3B29AC703C570A89479D47799F1482216E4F1F52FC` for this version
   
 ---
  
-# The `BasePlus` package, version: `1.39.0`;
+# The `BasePlus` package, version: `1.41.0`;
   
 ---
  
 
-# The BasePlus package [ver. 1.39.0] <a name="baseplus-package"></a> ###############################################
+# The BasePlus package [ver. 1.41.0] <a name="baseplus-package"></a> ###############################################
 
 The **BasePlus** package implements useful
 functions and functionalities I miss in the BASE SAS.
@@ -468,7 +468,7 @@ The `BasePlus` package consists of the following content:
 76. [`%workpath()` macro ](#workpath-macro-76 )
   
  
-95. [License note](#license)
+98. [License note](#license)
   
 ---
  
@@ -2018,6 +2018,11 @@ The basic syntax is the following, the `<...>` means optional parameters:
  <,roundFactor=>
  <,rainDropSize=>
  <,boxPlotSymbolSize=>
+ <,boxPlotLineSize=>
+ <,boxPlotFill=>
+ <,meanShiftLine=>
+ <,meanShiftStep=>
+ <,meanShiftColors=>
  <,colorsList=>
  <,monochrome=>
  <,antialiasMax=>
@@ -2025,6 +2030,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
  <,footnote=>
  <,catLabels=>
  <,xLabels=>
+ <,xBothAxis=>
  <,catLabelPos=> 
  <,xLabelPos=>
  <,catLabelAttrs=>
@@ -2038,17 +2044,26 @@ 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=>
  <,KERNEL_C=>
  <,VSCALEmax=>
+ <,minRange=>
+ <,maxRange=>
 
  <,cleanTempData=>
  <,codePreview=>
+ <,reuseN=>
 )
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -2089,6 +2104,28 @@ The basic syntax is the following, the `<...>` means optional parameters:
 
 * `boxPlotSymbolSize`  - *Optional*, default value `8px`.
                          Size of symbols on the box plot.
+                         If two values are provided, e.g., `16px 8px`,
+                         the first is used for diamond size (the mean), 
+                         the second for "min/max" bars.
+
+* `boxPlotLineSize`    - *Optional*, default value `1px`.
+                         Thickness of lines of the box plot.
+
+* `boxPlotFill`        - *Optional*, default value `1`.
+                         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.
@@ -2119,6 +2156,10 @@ The basic syntax is the following, the `<...>` means optional parameters:
                          When empty a data variable name is used.
                          For details see notes below.
 
+* `xBothAxis`          - *Optional*, default value is `1`. 
+                         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`.
                          Indicates position of the label on group axis (vertical).
                          Allowed values are `BOTTOM`, `CENTER`, `DATACENTER`, and `TOP`.
@@ -2142,7 +2183,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
                          Indicates if the right vertical axis should be displayed.
 
 * `y2axisLevels`       - *Optional*, default value `4`.
-                         Indicates if the number of expected levels of values printed 
+                         Sets the number of expected levels of values printed 
                          on the right vertical axis.
 
 * `y2axisValueAttrs`   - *Optional*, default value `Color=Grey`.
@@ -2165,11 +2206,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.
@@ -2209,6 +2273,14 @@ The basic syntax is the following, the `<...>` means optional parameters:
                          for `VSCALE=PROPORTION` between 0 and 1, and
                          for `VSCALE=COUNT` between 0 and N (sample size).
 
+* `minRange`           - *Optional*, default value is `.` (numerical missing).
+                         Indicates minimum value for x-axis on the plot, by default calculated form data.
+                         Is a global parameter used for all plots.
+
+* `maxRange`           - *Optional*, default value is `.` (numerical missing).
+                         Indicates maximum value for x-axis on the plot, by default calculated form data.
+                         Is a global parameter used for all plots.
+
 ***Other options***:
 
 * `cleanTempData`      - *Optional*, default value `1`.
@@ -2217,6 +2289,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: ###################################################################