Merge pull request #8 from SASPAC/dev

The BasePlus package [ver. 1.18.4]

README.md

@@ -21,9 +21,11 @@ format x bool.;
 %rainCloudPlot(sashelp.cars,DriveTrain,Invoice)
 
 %zipLibrary(sashelp,libOut=work)
+
+%bpPIPE(ls -la ~/)
 ```
 and more.
 
-SHA256 digest for the latest version of `BasePlus`: D8DBB7CC5952331FA59FEBBBDD15BC543FE3C89A8BA9150FE6AF5E412868EBE7
+SHA256 digest for the latest version of `BasePlus`: A6F1977DC4EC22A39DDC7BCE68CF562AF54351A3D385D488EC3067B5A7C0F3CB
 
 [**Documentation for BasePlus**](./baseplus.md "Documentation for BasePlus")

baseplus.md

@@ -49,14 +49,14 @@
   * [`%LDsNm()` macro](#ldsnm-macro)
   * [`%LVarNm()` macro](#lvarnm-macro)
   * [`%LVarNmLab()` macro](#lvarnmlab-macro)
-
+  * [`%bpPIPE()` macro](#bppipe-macro)
   
   
   * [License](#license)
   
 ---
 
-# The BasePlus package [ver. 1.17.3] <a name="baseplus-package"></a> ###############################################
+# The BasePlus package [ver. 1.18.4] <a name="baseplus-package"></a> ###############################################
 
 The **BasePlus** package implements useful
 functions and functionalities I miss in the BASE SAS.
@@ -220,63 +220,69 @@ data MyNextDataset;
 run;
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+**Example 12**: List, to the log, content of `home` directory.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
+%bpPIPE(ls -la ~/)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 ---
 
 Package contains: 
-1.   macro      deduplistc 
+1.   macro      bppipe 
-2.   macro      deduplistp 
+2.   macro      deduplistc 
-3.   macro      deduplists 
+3.   macro      deduplistp 
-4.   macro      deduplistx 
+4.   macro      deduplists 
-5.   macro      functionexists 
+5.   macro      deduplistx 
-6.   macro      getvars 
+6.   macro      functionexists 
-7.   macro      ldsn 
+7.   macro      getvars 
-8.   macro      ldsnm 
+8.   macro      ldsn 
-9.   macro      lvarnm 
+9.   macro      ldsnm 
-10.  macro      lvarnmlab 
+10.  macro      lvarnm 
-11.  macro      qdeduplistx 
+11.  macro      lvarnmlab 
-12.  macro      qgetvars 
+12.  macro      qdeduplistx 
-13.  macro      qzipevalf 
+13.  macro      qgetvars 
-14.  macro      raincloudplot 
+14.  macro      qzipevalf 
-15.  macro      symdelglobal 
+15.  macro      raincloudplot 
-16.  macro      unziplibrary 
+16.  macro      symdelglobal 
-17.  macro      zipevalf 
+17.  macro      unziplibrary 
-18.  macro      ziplibrary 
+18.  macro      zipevalf 
-19.  format     bool 
+19.  macro      ziplibrary 
-20.  format     boolz 
+20.  format     bool 
-21.  format     ceil 
+21.  format     boolz 
-22.  format     floor 
+22.  format     ceil 
-23.  format     int 
+23.  format     floor 
-24.  functions  arrfill 
+24.  format     int 
-25.  functions  arrfillc 
+25.  functions  arrfill 
-26.  functions  arrmissfill 
+26.  functions  arrfillc 
-27.  functions  arrmissfillc 
+27.  functions  arrmissfill 
-28.  functions  arrmisstoleft 
+28.  functions  arrmissfillc 
-29.  functions  arrmisstoleftc 
+29.  functions  arrmisstoleft 
-30.  functions  arrmisstoright 
+30.  functions  arrmisstoleftc 
-31.  functions  arrmisstorightc 
+31.  functions  arrmisstoright 
-32.  functions  bracketsc 
+32.  functions  arrmisstorightc 
-33.  functions  bracketsn 
+33.  functions  bracketsc 
-34.  functions  catxfc 
+34.  functions  bracketsn 
-35.  functions  catxfi 
+35.  functions  catxfc 
-36.  functions  catxfj 
+36.  functions  catxfi 
-37.  functions  catxfn 
+37.  functions  catxfj 
-38.  functions  deldataset 
+38.  functions  catxfn 
-39.  functions  semicolonc 
+39.  functions  deldataset 
-40.  functions  semicolonn 
+40.  functions  semicolonc 
-41.  format     brackets 
+41.  functions  semicolonn 
-42.  format     semicolon 
+42.  format     brackets 
-43.  proto      qsortincbyprocproto 
+43.  format     semicolon 
-44.  functions  frommissingtonumberbs 
+44.  proto      qsortincbyprocproto 
-45.  functions  fromnumbertomissing 
+45.  functions  frommissingtonumberbs 
-46.  functions  quicksort4notmiss 
+46.  functions  fromnumbertomissing 
-47.  functions  quicksorthash 
+47.  functions  quicksort4notmiss 
-48.  functions  quicksorthashsddv 
+48.  functions  quicksorthash 
-49.  functions  quicksortlight 
+49.  functions  quicksorthashsddv 
+50.  functions  quicksortlight
 
-*SAS package generated by generatePackage, version 20221125*
+*SAS package generated by generatePackage, version 20221215*
 
 The SHA256 hash digest for package BasePlus: 
-`D8DBB7CC5952331FA59FEBBBDD15BC543FE3C89A8BA9150FE6AF5E412868EBE7` 
+`A6F1977DC4EC22A39DDC7BCE68CF562AF54351A3D385D488EC3067B5A7C0F3CB` 
 
 ---
 # Content description ############################################################################################
@@ -3934,6 +3940,42 @@ The basic syntax is the following, the `<...>` means optional parameters:
 
 ---
 
+## >>> `%bpPIPE()` macro: <<< <a name="bppipe-macro"></a> #######################  
+
+The bpPIPE() [Base Plus PIPE] macro executes OS command
+and print to the log output of the execution.
+
+Under the hood it uses `_` filename reference to PIPE device.
+
+### SYNTAX: ###################################################################
+
+The basic syntax is the following, the `<...>` means optional parameters:
+~~~~~~~~~~~~~~~~~~~~~~~sas
+%bpPIPE( <OS command goes here> )
+~~~~~~~~~~~~~~~~~~~~~~~
+
+**Arguments description**:
+
+* **NO Arguments**    - Everything inside brackets is treated as an OS command.
+
+---
+
+### EXAMPLES AND USECASES: ####################################################
+
+**EXAMPLE 1.** List, to the log, content of D and C drives:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
+  %bpPIPE(D: & dir & dir "C:\")
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+**EXAMPLE 2.** List, to the log, content of `home` directory:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
+  %bpPIPE(ls -halt ~/)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+---
+
+
 ## License ####################################################################
 
 Copyright (c) since 2020 Bartosz Jablonski