Compare commits

...

40 Commits

Author SHA1 Message Date
yabwon
b76b1ed9eb Package BasePlus, version 1.1
Package BasePlus, version 1.1:

-New macro `%unzipLibrary()` added.
-Macro `%zipLibrary()` updated.
-The doc. updated.
2021-11-14 16:12:04 +01:00
yabwon
942879a5b8 Package BasePlus, version 1.0
Package BasePlus, version 1.0:

-New macro `%zipLibrary()` added.
-The doc. updated.
2021-11-13 22:51:01 +01:00
yabwon
fe631f9e44 Package GSM, version 0.17
Package GSM, version 0.17:

-New parameter `secret` added.
-The doc. updated.
2021-11-12 13:56:17 +01:00
yabwon
3f380b4e64 Package GSM, version 0.16
Package GSM, version 0.16:

-Check for the `SECURE` keyword added.
-Example in the doc. updated.
2021-11-12 11:43:12 +01:00
yabwon
02de8f0bc0 Package GSM, version 0.16
Package GSM, version 0.16:

-Check for the `SECURE` keyword added.
-Example in the doc. updated.
2021-11-12 11:11:39 +01:00
yabwon
7fa70d5ad4 SAS Packages Framework, version 20211111
**SAS Packages Framework**, version 20211111:

- The `packages` fileref can point to multiple directories now, e.g. `filename packages ("/dir/nr/one" "/dir/nr/two");`
- New macro `%extendPackagesFileref()` added,
- Help updated,

- Packages regenerated with new version of SPF:
   - DFA,
   - GSM,
   - MacroArray,
   - BasePlus,
   - dynMacroArray,
   - SQLinDS.
2021-11-10 20:21:07 +01:00
yabwon
98e822bde2 **GSM** (Generate Secure Macros) package, version 0.15
**GSM** (Generate Secure Macros) package, version 0.15

Doc. updated.
2021-11-05 13:48:39 +01:00
yabwon
2026254b96 BasePlus, version 0.994
**BasePlus, version 0.994**

Updates to the `%rainCloudPlot()` macro:
- new parameters,
-doc. updated.
2021-10-05 12:06:08 +02:00
yabwon
9ff8fd506c The BasePlus package [ver. 0.993]
The BasePlus package [ver. 0.993]:

- New macro `%rainCloudPlot()` added to the package.
- Doc. updated.
2021-10-01 21:20:03 +02:00
yabwon
7be17a3a57 GSM, version 0.14:
GSM, version 0.14:

- new parameter `encodingRestricted` added
- testing extended (runs for up to 600 macros, ~15kb each)
2021-09-08 11:55:54 +02:00
yabwon
e2e54b8025 **GSM** (Generate Secure Macros) package, version 0.13
**GSM** (Generate Secure Macros) package, version 0.13

Doc. updated.

The Package allows to create secured macros stored in SAS Proc FCMP functions. The dataset with functions can be shared between different operating systems and allows to generate macros on site without showing their code.
2021-08-19 08:36:25 +02:00
yabwon
cdf07fc232 BasePlus, Version: 0.992
**BasePlus**, Version: 0.992

New macro added.

The `%functionExists()` macro checks if a function exists in a SAS session.
2021-08-18 23:01:10 +02:00
Bart Jablonski
bcbd078b7d link to BASUG webinar updated 2021-07-29 15:59:47 +02:00
yabwon
c12260fdcd GSM (Generate Secure Macros) package, version 0.13
**GSM** (Generate Secure Macros) package, version 0.13

Bug fix.

The Package allows to create secured macros stored in SAS Proc FCMP functions. The dataset with functions can be shared between different operating systems and allows to generate macros on site without showing their code.
2021-07-26 17:00:30 +02:00
yabwon
b45b79fd3c **GSM** (Generate Secure Macros) package, version 0.12
**GSM** (Generate Secure Macros) package, version 0.12

The Package allows to create secured macros stored in SAS Proc FCMP functions. The dataset with functions can be shared between different operating systems and allows to generate macros on site without showing their code.
2021-07-22 15:09:36 +02:00
yabwon
2ce8a83499 **GSM** (Generate Secure Macros) package, version 0.11
**GSM** (Generate Secure Macros) package, version 0.11

The Package allows to create secured macros stored in SAS Proc FCMP functions. The dataset with functions can be shared between different operating systems and allows to generate macros on site without showing their code.
2021-07-19 12:58:52 +02:00
yabwon
59cda13330 GSM package, version 0.1
**GSM** (Generate Secure Macros) package, version 0.1

The Package allows to create secured macros stored in SAS Proc FCMP functions. The dataset with functions can be shared between different operating systems and allows to generate macros on site without showing their code.
2021-07-16 13:05:42 +02:00
yabwon
f7485ce6c4 **SAS Packages Framework**, version 20210528
**SAS Packages Framework**, version 20210528:

Help tags selection modified in the `%generatePackage()` macro.
New solution allows to write help tags surrounding comments in two ways.
The first (old) is:
```
/*** HELP START ***/
/*
comment
*/
/*** HELP END ***/
```

and the second (new):
```
/*** HELP START ***//*
comment
*//*** HELP END ***/
```
The second allows to print help info in log without `/*` and `*/` surrounding comments. It looks better and is easier for building `.md` files or other help documents (so you do not have to remove `/*` by hand).

Documentation updated.

The following packages were regenerated with new version of the SPF:
- BasePlus
- DFA
- dynMacroArray
- macroArray
- SQLinDS
2021-05-28 11:47:28 +02:00
yabwon
8f3cbe1b92 *SAS Packages Framework*, version 20210520
*SAS Packages Framework*, version 20210520

- SAS Global Forum 2021 refresh,
- ignore not `*.sas` files when generating the package.
2021-05-20 15:38:46 +02:00
Bart Jablonski
bc36780cee link to SAS Global Forum 2021 proceedings added
link to SAS Global Forum 2021 proceedings added
2021-05-18 10:29:22 +02:00
Bart Jablonski
3a0fc83433 link to SAS Global Forum 2021 video added 2021-05-16 22:32:06 +02:00
yabwon
b8905ca4a7 SAS Packages Framework, version 20210516
SAS Packages Framework, version 20210516

- explicit encoding added in zip filename reference in the %generatePacksge() macro
- minor spellings
2021-05-16 21:41:45 +02:00
yabwon
47426131a5 *SAS Packages Framework*, version 20210204
a spelling corrected
2021-04-26 20:33:20 +02:00
Bart Jablonski
8a23978694 Update README.md 2021-03-30 22:48:19 +02:00
yabwon
f3f3bc3688 Final version of SGF2021 article
Final version of SGF2021 article
2021-03-22 10:16:34 +01:00
yabwon
c2e06995f5 Documentation updated
Documentation updated:
- preprint of SAS Global Forum 2021 article added.
- files from the live demo added.
2021-02-05 22:44:01 +01:00
yabwon
40f3a00cb2 *SAS Packages Framework*, version 20210204
*SAS Packages Framework*, version 20210204

BugFix. In the testing part of the framework there may be situation when WorkspaceServer is not generating the log file. Manual log redirection was introduced.
2021-02-04 13:40:52 +01:00
yabwon
6f1f30fef9 *SAS Packages Framework*, version 20210203
*SAS Packages Framework*, version 20210203

Added test if during loading a macro from the package overwrites an existing macro in sasmacr catalog.
Documentation updated.
2021-02-03 21:12:17 +01:00
Bart Jablonski
78f202b150 Update README.md 2021-02-02 21:06:34 +01:00
yabwon
97d393bb71 SAS Packages Framework, version 20210122
SAS Packages Framework, version 20210122

New parameters to the `%installPackage()` macro added:
- `URLuser=` - A user name for the password protected URLs, no quotes needed.
- `URLpass=` - A password for the password protected URLs, no quotes needed.
- `URLoptions=` - Options for the `sourcePath` URLs filename. Consult the SAS documentation for the further details.
2021-01-22 16:46:27 +01:00
Bart Jablonski
98af4c8bc3 Update README.md 2021-01-17 21:15:55 +01:00
yabwon
c04d9c4eb2 DFA, version 0.5
DFA, version 0.5:
 - Optimisation of loading.
 - Documentation updated.
2021-01-17 21:05:14 +01:00
yabwon
8b65e85f3a Update Getting_Started_with_SAS_Packages.pdf 2021-01-11 14:14:58 +01:00
Bart Jablonski
582c12d908 Merge pull request #10 from yabwon/master
Master
2021-01-09 21:01:13 +01:00
yabwon
742e4ac3d3 **SAS Packages Framework**, version 20210109
**SAS Packages Framework**, version 20210109

Changes:
- type `formatS` added (mind the `S` at the end)
- testing extended:
  - test for existence of datasets
  - test for existence of macros

Documentation updated.

Packages recompiled with the new version of the SAS Packages Framework:
- `SQLinDS` (version 2.2)
- `macroArray` (version 0.8)
- `DFA` (version 0.4)
- `BasePlus` (version 0.991)
- `dynMacroArray` (version 0.2)
2021-01-09 17:22:32 +01:00
yabwon
74360b4cca DFA, version 0.4
Bitmaps added to the list of datastructures generaten by the DFA package.

New components:
-   proto      bit64andprotodfa
-   proto      bit64orprotodfa
-   function  bit64anddfa
-   function  bit64ordfa
-  macro      createdfbitmap
2020-12-29 22:32:32 +01:00
Bart Jablonski
aba2ee4f44 Update README.md 2020-12-26 22:10:17 +01:00
Bart Jablonski
55f4e35e0e Update README.md 2020-12-26 22:09:14 +01:00
Bart Jablonski
50f307f370 Merge pull request #9 from yabwon/main
SAS Packages Framework, version 20201209
2020-12-09 14:46:16 +01:00
Bart Jablonski
acd3a4872d Merge pull request #7 from yabwon/main
pull request
2020-12-07 20:45:48 +01:00
44 changed files with 2446 additions and 357 deletions

View File

@@ -1,6 +1,6 @@
MIT License
Copyright (c) since 2019 Bartosz Jablonski
Copyright (c) 2019 - 2021 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

View File

@@ -8,7 +8,7 @@ A **SAS package** is an automatically generated, single, stand alone *zip* file
The *purpose of a package* is to be a simple, and easy to access, code sharing medium, which will allow: on the one hand, to separate the code complex dependencies created by the developer from the user experience with the final product and, on the other hand, reduce developer's and user's unnecessary frustration related to a remote deployment process.
In this repository we are presenting the **SAS Packages Framework** which allows to develop and use SAS packages. The latest version of SPF is **`20201209`**.
In this repository we are presenting the **SAS Packages Framework** which allows to develop and use SAS packages. **The latest version** of SPF is **`20211111`**.
To get started with SAS Packages try this [**`Getting Started with SAS Packages`**](https://github.com/yabwon/SAS_PACKAGES/blob/main/SPF/Documentation/Getting_Started_with_SAS_Packages.pdf "Getting Started with SAS Packages") presentation (see the `./SPF/Documentation` directory).
@@ -16,11 +16,13 @@ The documentation and more advance reading would be the [**`SAS(r) packages - th
Short description of the SAS Packages Framework macros can be found [here](https://github.com/yabwon/SAS_PACKAGES/blob/main/SPF/SPFinit.md "Short description of the SAS Packages Framework macros")
**General overview video:**
**Videos** (the newer the better):
- [SAS Global Forum 2020 V.E.](https://www.youtube.com/watch?v=qCkb-bx0Dv8&t=0s "SGF2020") (April 2020)
- [Sasensei International Dojo](https://www.youtube.com/watch?v=BFhdUBQgjYQ&t=0s "SID no. 1") (April 2020)
- [SAS dla Administratorów i Praktyków 2020](https://www.youtube.com/watch?v=mXuep2k48Z8&feature=youtu.be&t=0s "SASAiP2020") (October 2020, in Polish)
- [Boston Area SAS Users Group webinar](https://us02web.zoom.us/rec/share/p6ZpCsvc5YZDQGpLOOLOB4zyNGA4vjfjJcNhwaGQ7jKKR00Z_bmeCcBkcwkut6Pr.Q6UoueYAOcv6dPQf "BASUG") (November 2020)
- [Boston Area SAS Users Group webinar](https://www.basug.org/videos?wix-vod-video-id=78067e61413d43d3a6951974b3bc3014&wix-vod-comp-id=comp-klv807gt "BASUG") (November 2020)
- [SAS Global Forum 2021 V.E.](https://www.youtube.com/watch?v=hqexaQtGw88 "SGF2021") (May 20th, 2021)
---
### The User:
@@ -32,7 +34,8 @@ and then either:
- Download the `SPFinit.sas` file (the SAS Packages Framework) into the local packages folder.
- \[Optional\] Manually download the `<packageName>.zip` file into the local packages folder.
- and Execute:
```
```sas
filename packages "<directory/containing/packages/>"; /* setup directory for packages */
%include packages(SPFinit.sas); /* enable the framework */
@@ -44,7 +47,7 @@ filename packages "<directory/containing/packages/>"; /* setup directory for pac
or if you need it just for "one time" only Execute:
```
```sas
filename packages "%sysfunc(pathname(work))"; /* setup temporary directory for packages in the WORK */
filename SPFinit url "https://raw.githubusercontent.com/yabwon/SAS_PACKAGES/main/SPF/SPFinit.sas";
%include SPFinit; /* enable the framework */
@@ -54,13 +57,14 @@ filename SPFinit url "https://raw.githubusercontent.com/yabwon/SAS_PACKAGES/main
%loadPackage(packageName) /* load the package content into the SAS session */
```
[**Workshop video for the User**](https://youtu.be/qX_-HJ76g8Y)\[May 6th, 2020\] [a bit outdated but gives the idea how it works]
[**Workshop video for the User**](https://youtu.be/qX_-HJ76g8Y) \[May 6th, 2020\] [a bit outdated but gives the idea how it works]
---
### The Developer:
To create your own package:
- Read the [**`SAS(r) packages - the way to share (a how to)- Paper 4725-2020 - extended.pdf`**](https://github.com/yabwon/SAS_PACKAGES/blob/main/SPF/Documentation/SAS(r)%20packages%20-%20the%20way%20to%20share%20(a%20how%20to)-%20Paper%204725-2020%20-%20extended.pdf "SAS packages - the way to share") to learn more details.
- Read the [**`SAS Packages - The Way to Share (a How-To) - Paper 4725-2020 - extended version`**](https://github.com/yabwon/SAS_PACKAGES/blob/main/SPF/Documentation/SAS(r)%20packages%20-%20the%20way%20to%20share%20(a%20how%20to)-%20Paper%204725-2020%20-%20extended.pdf "SAS packages - the way to share") article to learn more details.
- Read the **`My First SAS Package: A How-To - Paper 1079-2021`** article available at communities.sas.com [**`here`**](https://communities.sas.com/t5/SAS-Global-Forum-Proceedings/My-First-SAS-Package-A-How-To/ta-p/726319 "My First SAS Package: A How-To") or locally [**`here`**](https://github.com/yabwon/SAS_PACKAGES/blob/main/SPF/Documentation/Paper_1079-2021/My%20First%20SAS%20Package%20-%20a%20How%20To.pdf "My First SAS Package: A How-To")
- Download and use the `SPFinit.sas` file (the SAS Packages Framework), the part of the framework required for *testing* is there too.
---
@@ -69,6 +73,8 @@ To create your own package:
---
**Update**\[November 11th, 2021\]**:** `%extendPackagesFileref()` **macro is available**.
**Update**\[October 15th, 2020\]**:** `%previewPackage()` **macro is available**.
**Update**\[September 11th, 2020\]**:** ` %loadPackageS()` and `%verifyPackage()` **macros are available**.
@@ -95,12 +101,12 @@ The List:
Currently the following packages are available (see the `./packages` directory):
- **SQLinDS**\[2.2\], based on Mike Rhoads' article *Use the Full Power of SAS in Your Function-Style Macros*. The package allows to write SQL queries in the data step, e.g.
```
```sas
data class;
set %SQL(select * from sashelp.class order by age);
run;
```
SHA256 digest for SQLinDS: CE1A266B9030E5E336B45F53DF483F6913FD8AE88A2884CEE88BEEF621FDBD78
SHA256 digest for SQLinDS: F2BE3CC68C9A34DD324FD35C8287A4F89737E2E28E806E0DD7FB0EBF60F7C569
[Documentation for SQLinDS](https://github.com/yabwon/SAS_PACKAGES/blob/main/packages/sqlinds.md "Documentation for SQLinDS")
@@ -110,14 +116,14 @@ SHA256 digest for MacroCore: A23C29529F3CE7D0C8BEE9545C5D22D5B5594907547374A5135
[Documentation for MacroCore](https://core.sasjs.io "Documentation for MacroCore")
- **DFA** (Dynamic Function Arrays)\[0.3\], contains set of macros and FCMP functions which implement: a dynamically allocated array, a stack, a fifo queue, an ordered stack, and a priority queue, run `%helpPackage(DFA,createDFArray)` to find examples.
- **DFA** (Dynamic Function Arrays)\[0.5\], contains set of macros and FCMP functions which implement: a dynamically allocated array, a stack, a fifo queue, an ordered stack, and a priority queue, run `%helpPackage(DFA,createDFArray)` to find examples.
SHA256 digest for DFA: 1FC8D030D576C33F1B5DEB27E17534946209BC148D57A1357CA025ED1E69AEB8
SHA256 digest for DFA: C32A81304A411C1EB6BA7B76EDB8D70550F3935F35A1506E2B8019A2036FB5FF
[Documentation for DFA](https://github.com/yabwon/SAS_PACKAGES/blob/main/packages/dfa.md "Documentation for DFA")
- **macroArray**\[0.8\], implementation of an array concept in a macrolanguage, e.g.
```
```sas
%array(ABC[17] (111:127), macarray=Y);
%macro test();
@@ -135,13 +141,13 @@ SHA256 digest for DFA: 1FC8D030D576C33F1B5DEB27E17534946209BC148D57A1357CA025ED1
which = 1:H:2
);
```
SHA256 digest for macroArray: AC3AD58AFBBE459616743DC6346330BD8DD33FBA8CDD595423F181B67D0475BC
SHA256 digest for macroArray: 9FE227EF3144431B51063D599148BDD8873509D1B32F1AC2979EC566E1BB1487
[Documentation for macroArray](https://github.com/yabwon/SAS_PACKAGES/blob/main/packages/macroarray.md "Documentation for macroArray")
- **BasePlus**\[0.991\] adds a bunch of functionalities I am missing in BASE SAS, such as:
```
- **BasePlus**\[1.1\] adds a bunch of functionalities I am missing in BASE SAS, such as:
```sas
call arrMissToRight(myArray);
call arrFillMiss(17, myArray);
call arrFill(42, myArray);
@@ -153,13 +159,26 @@ string = catXFn("date9.", "#", myArray);
format x bool.;
%put %getVars(sashelp.class, pattern = ght$, sep = +, varRange = _numeric_);
%rainCloudPlot(sashelp.cars,DriveTrain,Invoice)
%zipLibrary(sashelp,libOut=work)
```
SHA256 digest for BasePlus: 9EA40F72191D1916189F043315CA519F6E42CEB05C186F7653AE464D21D21CFB
SHA256 digest for BasePlus: 319109732B5CBD99ADDA6D48EA26DA5236622F9C5D332F94EF282F1C9DCE73F9
[Documentation for BasePlus](https://github.com/yabwon/SAS_PACKAGES/blob/main/packages/baseplus.md "Documentation for BasePlus")
- **GSM** (Generate Secure Macros)\[0.17\], package allows
to create secured macros stored in SAS Proc FCMP functions.
The dataset with functions can be shared between different operating systems
and allows to generate macros on site without showing their code.
SHA256 digest for GSM: F6EE77A3C042E1E083E970BE255D126B52A75205DC1FB9A4A7337D0A89EEC7EB
[Documentation for GSM](https://github.com/yabwon/SAS_PACKAGES/blob/main/packages/gsm.md "Documentation for GSM")
- **dynMacroArray**\[0.2\], set of macros (wrappers for a hash table) emulating dynamic array in the data step (macro predecessor of DFA)
SHA256 digest for dynMacroArray: 5E8CCC88CC048A0B564CEE37C6CF4013857D9CFF3FA1B6B9AD6F719D08B30005
SHA256 digest for dynMacroArray: 9FE227EF3144431B51063D599148BDD8873509D1B32F1AC2979EC566E1BB1487
### ======

View File

@@ -0,0 +1,80 @@
/*one library "myLib" created in the (same named) subderectory of the "WORK" directory.*/
data _null_;
length rc0 $ 32767 rc1 rc2 8;
lib = "myLib";
rc0 = DCREATE(lib, "%sysfunc(pathname(work))/");
put rc0 = ;
rc1 = LIBNAME(lib, "%sysfunc(pathname(work))/" !! lib, "BASE");
rc2 = LIBREF (lib);
if rc2 NE 0 then
rc1 = LIBNAME(lib, "%sysfunc(pathname(work))", "BASE");
run;
libname myLib LIST;
/*two FCMP functions: "F1" and "F2", */
proc FCMP outlib = work.f.p;
function F1(n);
return (n+1);
endsub;
function F2(n);
return (n+2);
endsub;
run;
options cmplib = work.f;
/*one numeric format "fmtNum" and informat "infNum", */
proc FORMAT;
value fmtNum
low -< 0 = "negative"
0 = "zero"
0 <- high = "positive"
other = "missing"
;
invalue infNum
"negative" = -1
"zero" = 0
"positive" = 1
"missing" = .
other = 42
;
run;
/*one exemplary small dataset "myLib.smallDataset", and*/
data myLib.smallDataset;
do n = ., -1, 0, 1;
m = put(n, fmtNum.);
output;
end;
run;
/*one exemplary bigger dataset "myLib.biggerDataset".*/
data myLib.biggerDataset;
do i = ., -1e6 to 1e6;
j = put(i, fmtNum.);
k = ranuni(17);
output;
end;
run;
/*two macros: "mcrOne" and "mcrTwo" */
%macro mcrOne();
%put **Hi! This is macro &sysmacroname.**;
data _null_;
set myLib.smallDataset;
p = f1(n);
p + f2(n);
put (n p) (= fmtNum.);
run;
%mend mcrOne;
%macro mcrTwo(m=mcrOne);
%put **This is macro &sysmacroname.**;
%put **and I am calling the &m.**;
%&m.()
%put The answer is: %sysfunc(inputn("I don't know...", infNum.));
%mend mcrTwo;
/* %mcrTwo() */

View File

@@ -0,0 +1,4 @@
filename packages "~/saspackages";
%include packages(SPFinit.sas);
%generatePackage(~/saspackages/myPackage)

View File

@@ -0,0 +1,7 @@
filename packages "~/saspackages";
filename SPFinit url
"https://raw.githubusercontent.com/yabwon/SAS_PACKAGES/main/SPF/SPFinit.sas";
%include SPFinit;
%installPackage(SPFinit)

View File

@@ -0,0 +1,18 @@
/*** HELP START ***/
/*
`myLib` library
*/
/*** HELP END ***/
data _null_;
length rc0 $ 32767 rc1 rc2 8;
lib = "myLib";
rc0 = DCREATE(lib, "%sysfunc(pathname(work))/");
put rc0 = ;
rc1 = LIBNAME(lib, "%sysfunc(pathname(work))/" !! lib, "BASE");
rc2 = LIBREF (lib);
if rc2 NE 0 then
rc1 = LIBNAME(lib, "%sysfunc(pathname(work))", "BASE");
run;
libname myLib LIST;

View File

@@ -0,0 +1,9 @@
/*** HELP START ***/
/*
`F1` function
*/
/*** HELP END ***/
function F1(n);
return (n+1);
endsub;

View File

@@ -0,0 +1,9 @@
/*** HELP START ***/
/*
`F2` function
*/
/*** HELP END ***/
function F2(n);
return (n+2);
endsub;

View File

@@ -0,0 +1,12 @@
/*** HELP START ***/
/*
`fmtNum` format
*/
/*** HELP END ***/
value fmtNum
low -< 0 = "negative"
0 = "zero"
0 <- high = "positive"
other = "missing"
;

View File

@@ -0,0 +1,13 @@
/*** HELP START ***/
/*
`infNum` informat
*/
/*** HELP END ***/
invalue infNum
"negative" = -1
"zero" = 0
"positive" = 1
"missing" = .
other = 42
;

View File

@@ -0,0 +1,12 @@
/*** HELP START ***/
/*
`myLib.smallDataset` data
*/
/*** HELP END ***/
data myLib.smallDataset;
do n = ., -1, 0, 1;
m = put(n, fmtNum.);
output;
end;
run;

View File

@@ -0,0 +1,13 @@
/*** HELP START ***/
/*
`myLib.biggerDataset` data
*/
/*** HELP END ***/
data myLib.biggerDataset;
do i = ., -1e6 to 1e6;
j = put(i, fmtNum.);
k = ranuni(17);
output;
end;
run;

View File

@@ -0,0 +1,15 @@
/*** HELP START ***/
/*
`mcrOne` macro
*/
/*** HELP END ***/
%macro mcrOne();
%put **Hi! This is macro &sysmacroname.**;
data _null_;
set myLib.smallDataset;
p = f1(n);
p + f2(n);
put (n p) (= fmtNum.);
run;
%mend mcrOne;

View File

@@ -0,0 +1,30 @@
/*** HELP START ***/
/*
## General Info: ##
The `%mcrTwo()` macro is the main macro of the package.
It has one key-value parameter `m` with default value `mcrOne`.
*/
/*** HELP END ***/
%macro mcrTwo(m=mcrOne);
%put **This is macro &sysmacroname.**;
%put **and I am calling the &m.**;
%&m.()
%put The answer is: %sysfunc(inputn("I don't know...", infNum.));
%mend mcrTwo;
/*** HELP START ***/
/*
## Examples: ##
Example 1. Basic use-case:
~~~~~~~~~~~~~~~~~~~~~~~~~~
%mcrTwo(m=mcrOne)
~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/*** HELP END ***/

View File

@@ -0,0 +1,21 @@
Type: Package
Package: myPackage
Title: My first SAS package.
Version: 1.0
Author: John Smith (john.smith@mail.com)
Maintainer: Jane Smith (jane.smith@mail.com)
License: MIT
Encoding: UTF8
Required: "Base SAS Software"
DESCRIPTION START:
## The myPackage ##
The `myPackage` is my first SAS package and
for sure it won't be the last package!
It was created during SAS Global Forum 2021
virtual event.
It helps me to share my code with other SAS users!
DESCRIPTION END:

View File

@@ -0,0 +1,2 @@
%mcrTwo(m=mcrOne)

View File

@@ -0,0 +1,14 @@
## General Info: ##
The `%mcrTwo()` macro is the main macro of the package.
It has one key-value parameter `m` with default value `mcrOne`.
## Examples: ##
Example 1. Basic use-case:
~~~~~~~~~~~~~~~~~~~~~~~~~~
%mcrTwo(m=mcrOne)
~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@@ -8,7 +8,8 @@
* [the `listPackages` macro](#listpackages)
* [the `verifyPackage` macro](#verifypackage)
* [the `previewPackage` macro](#previewPackage)
* [the `generatePackage` macro](#generatepackage)
* [the `generatePackage` macro](#generatepackage)
* [the `extendPackagesFileref` macro](#extendpackagesfileref)
* [Some more examples](#some-more-examples)
---
@@ -20,7 +21,7 @@ A **SAS package** is an automatically generated, single, stand alone *zip* file
The *purpose of a package* is to be a simple, and easy to access, code sharing medium, which will allow: on the one hand, to separate the code complex dependencies created by the developer from the user experience with the final product and, on the other hand, reduce developer's and user's unnecessary frustration related to a remote deployment process.
In this repository we are presenting the **SAS Packages Framework** which allows to develop and use SAS packages. The latest version of SPF is **`20201209`**.
In this repository we are presenting the **SAS Packages Framework** which allows to develop and use SAS packages. The latest version of SPF is **`20211111`**.
**To get started with SAS Packages** try this [**`Getting Started with SAS Packages`**](https://github.com/yabwon/SAS_PACKAGES/blob/main/SPF/Documentation/Getting_Started_with_SAS_Packages.pdf "Getting Started with SAS Packages") presentation (see the `./SPF/Documentation` directory).
@@ -38,7 +39,7 @@ After assigning the directory do not change them when using the SPF since it may
## This is short help information for the `installPackage` macro <a name="installpackage"></a>
--------------------------------------------------------------------------------------------
Macro to install SAS packages, version `20201209`
Macro to install SAS packages, version `20211111`
A SAS package is a zip file containing a group
of SAS codes (macros, functions, data steps generating
@@ -48,6 +49,9 @@ After assigning the directory do not change them when using the SPF since it may
in the packages folder. The process of installation is equivalent with
manual downloading the package zip file into the packages folder.
In case the packages fileref is a multi-directory one the first directory
will be selected as a destination.
--------------------------------------------------------------------------------------------
### Parameters:
@@ -60,13 +64,22 @@ After assigning the directory do not change them when using the SPF since it may
If the package name is *SPFinit* or *SASPackagesFramework*
then the framework itself is downloaded.
- `sourcePath=` Location of the package, e.g. "www.some.web.page/" (mind the "/" at the end of the path!) <br>
Current default location for packages is: <br> `https://raw.githubusercontent.com/yabwon/SAS_PACKAGES/main/packages/` <br>
Current default location for the framework is: <br> `https://raw.githubusercontent.com/yabwon/SAS_PACKAGES/main/SPF/`
- `sourcePath=` Location of the package, e.g. "www.some.web.page/" (mind the "/" at the end of the path!)
Current default location for packages is:
`https://raw.githubusercontent.com/yabwon/SAS_PACKAGES/main/packages/`
Current default location for the framework is:
`https://raw.githubusercontent.com/yabwon/SAS_PACKAGES/main/SPF/`
- `replace=` With default value of `1` it causes existing package file
to be replaceed by new downloaded file.
- `URLuser=` A user name for the password protected URLs, no quotes needed.
- `URLpass=` A password for the password protected URLs, no quotes needed.
- `URLoptions=` Options for the `sourcePath` URLs filename. Consult the SAS
documentation for the further details.
--------------------------------------------------------------------------------------------
Visit: `https://github.com/yabwon/SAS_PACKAGES/tree/main/SPF/Documentation` to learn more.
@@ -95,7 +108,7 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
## This is short help information for the `helpPackage` macro <a name="helppackage"></a>
-------------------------------------------------------------------------------
Macro to get help about SAS packages, version `20201209`
Macro to get help about SAS packages, version `20211111`
A SAS package is a zip file containing a group
of SAS codes (macros, functions, data steps generating
@@ -165,7 +178,7 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
## This is short help information for the `loadPackage` macro <a name="loadpackage"></a>
-------------------------------------------------------------------------------
Macro to *load* SAS packages, version `20201209`
Macro to *load* SAS packages, version `20211111`
A SAS package is a zip file containing a group
of SAS codes (macros, functions, data steps generating
@@ -238,7 +251,7 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
## This is short help information for the `loadPackageS` macro <a name="loadpackages"></a>
-------------------------------------------------------------------------------
Macro wrapper for the loadPackage macro, version `20201209`
Macro wrapper for the loadPackage macro, version `20211111`
A SAS package is a zip file containing a group
of SAS codes (macros, functions, data steps generating
@@ -287,7 +300,7 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
## This is short help information for the `unloadPackage` macro <a name="unloadpackage"></a>
-------------------------------------------------------------------------------
Macro to unload SAS packages, version `20201209`
Macro to unload SAS packages, version `20211111`
A SAS package is a zip file containing a group
of SAS codes (macros, functions, data steps generating
@@ -352,7 +365,7 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
## This is short help information for the `listPackages` macro <a name="listpackages"></a>
-----------------------------------------------------------------------------------------
Macro to list available SAS packages, version `20201209`
Macro to list available SAS packages, version `20211111`
A SAS package is a zip file containing a group
of SAS codes (macros, functions, data steps generating
@@ -393,7 +406,7 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
## This is short help information for the `verifyPackage` macro <a name="verifypackage"></a>
-------------------------------------------------------------------------------
Macro to verify SAS package with it hash digest, version `20201209`
Macro to verify SAS package with it hash digest, version `20211111`
A SAS package is a zip file containing a group
of SAS codes (macros, functions, data steps generating
@@ -439,14 +452,14 @@ filename packages "C:/SAS_PACKAGES"; %* set-up a directory for packages;
%include packages(SPFinit.sas); %* enable the framework;
%installPackage(SQLinDS) %* install the package from the Internet;
%verifPackage(SQLinDS, %* verify the package with provided hash;
%verifyPackage(SQLinDS, %* verify the package with provided hash;
hash=HDA478ANJ3HKHRY327FGE88HF89VH89HFFFV73GCV98RF390VB4)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## This is short help information for the `previewPackage` macro <a name="previewpackage"></a>
-------------------------------------------------------------------------------
Macro to get previwe of a SAS packages, version `20201209`
Macro to get previwe of a SAS packages, version `20211111`
A SAS package is a zip file containing a group
of SAS codes (macros, functions, data steps generating
@@ -507,13 +520,13 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
%include packages(SPFinit.sas); %* enable the framework;
%installPackage(SQLinDS) %* install the package from the Internet;
%previewpPackage(SQLinDS) %* get content of the package;
%previewPackage(SQLinDS) %* get content of the package;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## This is short help information for the `generatePackage` macro <a name="generatepackage"></a>
-------------------------------------------------------------------------------
Macro to generate SAS packages, version `20201209`
Macro to generate SAS packages, version `20211111`
A SAS package is a zip file containing a group
of SAS codes (macros, functions, data steps generating
@@ -544,6 +557,8 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
- `packages=` Location of other packages for testing
if there are dependencies in loading the package.
Has to be a single directory, if more than one are
provided than only the first is used.
- `testResults=` Location where tests results should be stored,
if null (the default) then the session WORK is used.
@@ -598,6 +613,8 @@ can be used to order multiple types in the way you wish.
The "tree structure" of the folder could be for example as follows:
All files have to have `.sas` extension. Other files are ignored.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
<packageName>
..
@@ -682,6 +699,45 @@ The "tree structure" of the folder could be for example as follows:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------------------------------------------------------------------------
## This is short help information for the `extendPackagesFileref` macro <a name="extendpackagesfileref"></a>
-----------------------------------------------------------------------------------------
Macro to list directories pointed by 'packages' fileref, version `20211111`
A SAS package is a zip file containing a group
of SAS codes (macros, functions, data steps generating
data, etc.) wrapped up together and embedded inside the zip.
The `%extendPackagesFileref()` macro lists directories pointed by
the packages fileref. It allows to add new dierctories to packages folder list.
### Parameters:
1. `packages` *Optional.* A valid fileref name, when empty the "packages" is used
When used as: `%extendPackagesFileref(HELP)` it displays this help information.
------------------------------------------------------------------------------------------
Visit: `https://github.com/yabwon/SAS_PACKAGES/tree/main/SPF/Documentation`
to learn more.
### Example ###################################################################
Enabling the SAS Package Framework
from the local directory and adding
new directory.
Assume that the `SPFinit.sas` file
is located in one of "C:/SAS_PK1" or "C:/SAS_PK2" folders.
Run the following code in your SAS session:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
filename packages ("C:/SAS_PK1" "C:/SAS_PK2"); %* setup a directory for packages;
%include packages(SPFinit.sas); %* enable the framework;
filename packages ("D:/NEW_DIR" %extendPackagesFileref()); %* add new directory;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-------------------------------------------------------------------------------

File diff suppressed because it is too large Load Diff

View File

@@ -1,4 +1,4 @@
Copyright (c) 2019 - 2020 Bartosz Jablonski
Copyright (c) 2019 - 2021 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

View File

@@ -7,7 +7,7 @@ Currently the following packages are available:
---
- **SQLinDS**\[2.2\], based on Mike Rhoads' article *Use the Full Power of SAS in Your Function-Style Macros*. The package allows to write SQL queries in the data step, e.g.
```
```sas
data class;
set %SQL(
select age, name, weight, height
@@ -18,7 +18,7 @@ data class;
WH = weight + height;
run;
```
SHA256 digest for SQLinDS: CE1A266B9030E5E336B45F53DF483F6913FD8AE88A2884CEE88BEEF621FDBD78
SHA256 digest for SQLinDS: F2BE3CC68C9A34DD324FD35C8287A4F89737E2E28E806E0DD7FB0EBF60F7C569
[Documentation for SQLinDS](https://github.com/yabwon/SAS_PACKAGES/blob/main/packages/sqlinds.md "Documentation for SQLinDS")
@@ -32,8 +32,8 @@ SHA256 digest for MacroCore: A23C29529F3CE7D0C8BEE9545C5D22D5B5594907547374A5135
---
- **DFA** (Dynamic Function Arrays)\[0.3\], contains set of macros and FCMP functions which implement: a dynamically allocated array, a stack, a fifo queue, an ordered stack, and a priority queue, run `%helpPackage(DFA,createDFArray)` to find examples.
```
- **DFA** (Dynamic Function Arrays)\[0.5\], contains set of macros and FCMP functions which implement: a dynamically allocated array, a stack, a fifo queue, an ordered stack, and a priority queue, run `%helpPackage(DFA,createDFArray)` to find examples.
```sas
%createDFArray(ArrDynamic, resizefactor=17);
data _null_;
@@ -59,14 +59,14 @@ data _null_;
end;
run;
```
SHA256 digest for DFA: 1FC8D030D576C33F1B5DEB27E17534946209BC148D57A1357CA025ED1E69AEB8
SHA256 digest for DFA: C32A81304A411C1EB6BA7B76EDB8D70550F3935F35A1506E2B8019A2036FB5FF
[Documentation for DFA](https://github.com/yabwon/SAS_PACKAGES/blob/main/packages/dfa.md "Documentation for DFA")
---
- **macroArray**\[0.8\], implementation of an array concept in a macro language, e.g.
```
```sas
%array(ABC[17] (111:127), macarray=Y);
%macro test();
@@ -84,14 +84,14 @@ SHA256 digest for DFA: 1FC8D030D576C33F1B5DEB27E17534946209BC148D57A1357CA025ED1
which = 1:H:2
);
```
SHA256 digest for macroArray: AC3AD58AFBBE459616743DC6346330BD8DD33FBA8CDD595423F181B67D0475BC
SHA256 digest for macroArray: 70032D27081A0EE15BC82B8F14D2A61700FA7C1F0D88B4DB516AB433CD06C4D3
[Documentation for macroArray](https://github.com/yabwon/SAS_PACKAGES/blob/main/packages/macroarray.md "Documentation for macroArray")
---
- **BasePlus**\[0.991\] adds a bunch of functionalities I am missing in BASE SAS, such as:
```
- **BasePlus**\[1.1\] adds a bunch of functionalities I am missing in BASE SAS, such as:
```sas
call arrMissToRight(myArray);
call arrFillMiss(17, myArray);
call arrFill(42, myArray);
@@ -103,15 +103,30 @@ string = catXFn("date9.", "#", myArray);
format x bool.;
%put %getVars(sashelp.class, pattern = ght$, sep = +, varRange = _numeric_);
%rainCloudPlot(sashelp.cars,DriveTrain,Invoice)
%zipLibrary(sashelp,libOut=work)
```
SHA256 digest for BasePlus: 9EA40F72191D1916189F043315CA519F6E42CEB05C186F7653AE464D21D21CFB
SHA256 digest for BasePlus: 319109732B5CBD99ADDA6D48EA26DA5236622F9C5D332F94EF282F1C9DCE73F9
[Documentation for BasePlus](https://github.com/yabwon/SAS_PACKAGES/blob/main/packages/baseplus.md "Documentation for BasePlus")
---
- **dynMacroArray**\[0.2\], set of macros (wrappers for a hash table) emulating dynamic array in the data step (macro predecessor of DFA)
- **GSM** (Generate Secure Macros)\[0.17\], package allows
to create secured macros stored in SAS Proc FCMP functions.
The dataset with functions can be shared between different operating systems
and allows to generate macros on site without showing their code.
SHA256 digest for dynMacroArray: 5E8CCC88CC048A0B564CEE37C6CF4013857D9CFF3FA1B6B9AD6F719D08B30005
SHA256 digest for GSM: F6EE77A3C042E1E083E970BE255D126B52A75205DC1FB9A4A7337D0A89EEC7EB
[Documentation for GSM](https://github.com/yabwon/SAS_PACKAGES/blob/main/packages/gsm.md "Documentation for GSM")
---
- **dynMacroArray**\[0.2\], set of macros (wrappers for a hash table) emulating dynamic array in the data step (macro predecessor of DFA)
SHA256 digest for dynMacroArray: 9FE227EF3144431B51063D599148BDD8873509D1B32F1AC2979EC566E1BB1487
---

View File

@@ -1,3 +1,67 @@
/* 20211114 */
BasePlus: 319109732B5CBD99ADDA6D48EA26DA5236622F9C5D332F94EF282F1C9DCE73F9
/* 20211113 */
BasePlus: 4EDB786B9D6F6D6C5741B5CAC1CB169DD10D8196600B2CB385DDE479A54F0FA3
/* 20211112 */
GSM: F6EE77A3C042E1E083E970BE255D126B52A75205DC1FB9A4A7337D0A89EEC7EB
/* 20211111 */
BasePlus: B34E352EC52E05B8BBE1816E6104F47677CBFDEAF7CD71B8BF04FDBFA01B0EF0
DFA: C32A81304A411C1EB6BA7B76EDB8D70550F3935F35A1506E2B8019A2036FB5FF
dynMacroArray: 9FE227EF3144431B51063D599148BDD8873509D1B32F1AC2979EC566E1BB1487
GSM: BEFAA87266D6DBA3D5983117FC36A24DE03A2F93791AC786DCDB37571A4494AC
macroArray: 70032D27081A0EE15BC82B8F14D2A61700FA7C1F0D88B4DB516AB433CD06C4D3
SQLinDS: F2BE3CC68C9A34DD324FD35C8287A4F89737E2E28E806E0DD7FB0EBF60F7C569
/* 20211105 */
GSM: 3EAF6E93642CCA9B5B592DF9BED4C8B20B60BCD4B0434720D12D26096717C4A9
/* 20211005 */
BasePlus: D01BDFB50EF023EF51806F5F0ED664523C1A6F25AA2778808558C212E6D74725
/* 20211001 */
BasePlus: 5EAEF846754F19759C0492308478417C9667C9651F1EF14F70E4FF8AB4C857F6
/* 20210908 */
GSM: 93D88D4465B68984E938212241DE55C7B12EBC20601538553AC9E1AC0628C006
/* 20210818 */
BasePlus: C9D26CAC2504634EF25F02B5BD04596B2F873E3C25E8CEDDD7F496A78B184E9F
/* 20210726 */
GSM: 2FC239B5A2216D073826125999BFD64FBA32BFEA3EE6EA2B22EC64E8C1B04144
/* 20210722 */
GSM: 311BCF510B7B189AE9A75C56C4D2F99F844114CC5AD32329FAD690BA1F10422A
/* 20210719 */
GSM: 4322D79C382B9D58EF5E51AFD0856331F8B38B1B35AC21295DADFC43F81B2AF8
/* 20210716 */
GSM: 7134C8672023972BA0D5D5CE1E611F0DBB5F60ADAE847BC59C94FF7E2BEC0278
/* 20210528 */
BasePlus: A321A4BC54D444B82575EC5D443553A096557AD69DC171D578A330277E67637A
DFA: 22AB51B85E3344B8C0FB7AF164247881B656F5CBA88BBA974AD8BC41ED79327F
dynMacroArray: 67956116578E71327748B7EB3DAFF9D872DBC6F6EDD0DC11B7CF2A54FDA71785
macroArray: 849629D3AF3FE3AB45D86990E303F1D5E4D5F9F31C8ED6864C95B0DFAADCA445
SQLinDS: 1853CD6262CF66582A33C373AA612CA714B61CB88A1C51745E7A57D5A03C39B4
/* 20210117 */
DFA: 179AAB9DF3DE8F049A4EFDF5FB0BE92AE5F7BFA7708D4365F39D4DC71C4F90FE
/* 20210109 */
BasePlus: 28F3DE865C5E3B914FFB7CC2627D8B0975527EEECEE7AFEAD7B335C3FDC1BFD3
DFA: E777D4578DFDEB2277D58264BAB5BFDBEAFD4E538D4831CDCBFFB4216D2441C2
dynMacroArray: 8B0777EA3CF41968C0B029AA57B1F809D21D1BAB1B88A35B0EA5DB3C6DD9E748
macroArray: 42E87B80450B3E1AD462B9B63B41F34C83B7745AA0F98C3CA72AA19F3B1FF10E
SQLinDS: 3034A0C8AC43683AD55698861DBBDEBDE6FC8567D59ECF2BB5F3389FE6BC8062
/* 20201229 */
DFA: 5B41657A8A3BEAD185B13D072BC54902AB81FEAD32330DA8ABA90CF777D4D76E
/* 20201207 */
macroArray: AC3AD58AFBBE459616743DC6346330BD8DD33FBA8CDD595423F181B67D0475BC
BasePlus: 9EA40F72191D1916189F043315CA519F6E42CEB05C186F7653AE464D21D21CFB

View File

@@ -1,5 +1,5 @@
/*** HELP START ***/
/*
/*** HELP START ***//*
## >>> library `dsSQL`: <<< <a name="library-dssql"></a> ########################
The `dsSQL` library stores temporary views
@@ -15,8 +15,8 @@ if not possible, then redirects to the `WORK` location, like:
LIBNAME dsSQL BASE "%sysfunc(pathname(WORK))";
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---
*/
/*** HELP END ***/
*//*** HELP END ***/
data _null_;
length rc0 $ 32767 rc1 rc2 8;

View File

@@ -1,5 +1,5 @@
/*** HELP START ***/
/*
/*** HELP START ***//*
## >>> `%dsSQL_Inner()` macro: <<< <a name="dssql-inner-macro"></a> #############
**Internal** macro called by `dsSQL()` function.
@@ -9,8 +9,8 @@ which is then stored in the `dsSQL` library.
Recommended for *SAS 9.3* and higher.
---
*/
/*** HELP END ***/
*//*** HELP END ***/
/* inner macro */
%MACRO dsSQL_Inner() / secure;

View File

@@ -1,5 +1,5 @@
/*** HELP START ***/
/*
/*** HELP START ***//*
## >>> `%SQL()` macro: <<< <a name="dssql-macro"></a> ###########################
The **main** macro which allows to use
@@ -41,8 +41,8 @@ data dictionary;
run;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---
*/
/*** HELP END ***/
*//*** HELP END ***/
/* Main User macro */

View File

@@ -1,5 +1,5 @@
/*** HELP START ***/
/*
/*** HELP START ***//*
## >>> `dsSQL()` function: <<< <a name="dssql-function"></a> ####################
**Internal** function called by the `%SQL()` macro.
@@ -20,8 +20,8 @@ dsSQL(unique_index_2, query)
2. `query` - *Character*, internal variable, contains query text.
---
*/
/*** HELP END ***/
*//*** HELP END ***/
proc fcmp
/*inlib = work.&packageName.fcmp*/

View File

@@ -41,12 +41,16 @@
* [`semicolonN()` function](#semicolonn-function)
* [`%zipEvalf()` macro](#zipevalf-macro)
* [`%QzipEvalf()` macro](#qzipevalf-macro)
* [`%functionExists()` macro](#functionexists-macro)
* [`%RainCloudPlot()` macro](#raincloudplot-macro)
* [`%zipLibrary()` macro](#ziplibrary-macro)
* [`%unzipLibrary()` macro](#unziplibrary-macro)
* [License](#license)
---
# The BasePlus package [ver. 0.991] <a name="baseplus-package"></a> ###############################################
# The BasePlus package [ver. 1.1] <a name="baseplus-package"></a> ###############################################
The **BasePlus** package implements useful
functions and functionalities I miss in the BASE SAS.
@@ -61,7 +65,9 @@ Kudos to all who inspired me to generate this package:
*Mark Keintz*,
*Paul Dorfman*,
*Richard DeVenezia*,
*Christian Graffeuille*.
*Christian Graffeuille*,
*Allan Bowe*,
*Anamaria Calai*.
---
@@ -164,7 +170,7 @@ Kudos to all who inspired me to generate this package:
run;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Example 7**: Deduplicate values from a space separated list.
**Example 7**: De-duplicate values from a space separated list.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%let list = 4 5 6 1 2 3 1 2 3 4 5 6;
%put *%dedupListS(&list.)*;
@@ -176,55 +182,77 @@ Kudos to all who inspired me to generate this package:
%put &=x;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Example 9**: Simple Rain Cloud plot.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%rainCloudPlot(sashelp.cars,DriveTrain,Invoice)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
![Rain Cloud Plot](./baseplus_RainCloudPlot_Ex0_9.png)
**Example 10**: Zip SAS library.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%zipLibrary(sashelp, libOut=work)
%unzipLibrary(%sysfunc(pathname(work)), zip=sashelp, mode=S, clean=1)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---
Package contains:
1. macro deduplistc
2. macro deduplistp
3. macro deduplists
4. macro deduplistx
5. macro getvars
6. macro qdeduplistx
7. macro qgetvars
8. macro qzipevalf
9. macro symdelglobal
10. macro zipevalf
11. format bool
12. format boolz
13. format ceil
14. format floor
15. format int
16. functions arrfill
17. functions arrfillc
18. functions arrmissfill
19. functions arrmissfillc
20. functions arrmisstoleft
21. functions arrmisstoleftc
22. functions arrmisstoright
23. functions arrmisstorightc
24. functions bracketsc
25. functions bracketsn
26. functions catxfc
27. functions catxfi
28. functions catxfj
29. functions catxfn
30. functions deldataset
31. functions semicolonc
32. functions semicolonn
33. format brackets
34. format semicolon
35. proto qsortincbyprocproto
36. functions frommissingtonumberbs
37. functions fromnumbertomissing
38. functions quicksort4notmiss
39. functions quicksorthash
40. functions quicksorthashsddv
41. functions quicksortlight
1. macro deduplistc
2. macro deduplistp
3. macro deduplists
4. macro deduplistx
5. macro functionexists
6. macro getvars
7. macro qdeduplistx
8. macro qgetvars
9. macro qzipevalf
10. macro raincloudplot
11. macro symdelglobal
12. macro unziplibrary
13. macro zipevalf
14. macro ziplibrary
15. format bool
16. format boolz
17. format ceil
18. format floor
19. format int
20. functions arrfill
21. functions arrfillc
22. functions arrmissfill
23. functions arrmissfillc
24. functions arrmisstoleft
25. functions arrmisstoleftc
26. functions arrmisstoright
27. functions arrmisstorightc
28. functions bracketsc
29. functions bracketsn
30. functions catxfc
31. functions catxfi
32. functions catxfj
33. functions catxfn
34. functions deldataset
35. functions semicolonc
36. functions semicolonn
37. format brackets
38. format semicolon
39. proto qsortincbyprocproto
40. functions frommissingtonumberbs
41. functions fromnumbertomissing
42. functions quicksort4notmiss
43. functions quicksorthash
*SAS package generated by generatePackage, version 20201115*
*SAS package generated by generatePackage, version 20211111*
The SHA256 hash digest for package BasePlus:
`9EA40F72191D1916189F043315CA519F6E42CEB05C186F7653AE464D21D21CFB`
`319109732B5CBD99ADDA6D48EA26DA5236622F9C5D332F94EF282F1C9DCE73F9`
---
# Content description ############################################################################################
@@ -2929,8 +2957,544 @@ run;
---
## >>> `%functionExists()` macro: <<< <a name="functionexists-macro"></a> #######################
The functionExists() macro function tests
if given funcion exists in the SAS session.
The `sashelp.vfunc` view is used.
See examples below for the details.
The `%functionExists()` macro executes like a pure macro code.
The function is a result of cooperation with [Allan Bowe](https://www.linkedin.com/in/allanbowe/)
### SYNTAX: ###################################################################
The basic syntax is the following, the `<...>` means optional parameters:
~~~~~~~~~~~~~~~~~~~~~~~sas
%functionExists(
funName
)
~~~~~~~~~~~~~~~~~~~~~~~
**Arguments description**:
1. `funName` - *Required*, the name of the function
existence of which you are testing.
### EXAMPLES AND USECASES: ####################################################
**EXAMPLE 1.** Test if function exists:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%put %functionExists(HASHING);
%put %functionExists(COSsinLOG);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---
## >>> `%RainCloudPlot()` macro: <<< <a name="raincloudplot-macro"></a> #######################
The RainCloudPlot() macro allow to plot Rain Cloud plots, i.e. pots of
kernel density estimates, jitter data values, and box-and-whiskers plot.
See examples below for the details.
### SYNTAX: ###################################################################
The basic syntax is the following, the `<...>` means optional parameters:
~~~~~~~~~~~~~~~~~~~~~~~sas
%RainCloudPlot(
DS
,gr
,vars
<,WidthPX=>
<,HeightPX=>
<,boxPlot=>
<,roundFactor=>
<,rainDropSize=>
<,boxPlotSymbolSize=>
<,colorsList=>
<,monochrome=>
<,antialiasMax=>
<,title=>
<,footnote=>
<,catLabels=>
<,xLabels=>
<,catLabelPos=>
<,xLabelPos=>
<,formated=>
<,y2axis=>
<,y2axisLevels=>
<,y2axisValueAttrs=>
<,xaxisValueAttrs=>
<,xaxisTickstyle=>
<,VSCALE=>
<,KERNEL_K=>
<,KERNEL_C=>
<,cleanTempData=>
)
~~~~~~~~~~~~~~~~~~~~~~~
**Arguments description**:
1. `DS` - *Required*, name of the dataset from
which variables are to be taken.
2. `gr` - *Required*, name of the grouping variable.
When more than one variable is specified
separate plots are rendered.
Can be numeric or character.
3. `vars` - *Required*, name of the aggregated numeric variable.
When more than one variable is specified
separate plots are rendered.
***Plot related options***:
* `WidthPX` - *Optional*, default value `1200`.
Total width of the plot in pixels.
* `HeightPX` - *Optional*, default value `220`.
Partial height of the plot in pixels.
Total height is calculated as `#GROUPS x HeightPX`.
* `boxPlot` - *Optional*, default value `1`.
Indicates if the Box Plot should be added.
* `roundFactor` - *Optional*, default value `0.000001`.
Rounding level when calculating maximum value
of the cloud chart. Should be adjusted to data
granularity level, e.g. for data with value
around `1e-8` should be decreased.
* `rainDropSiz` - *Optional*, default value `5px`.
Size of data points in the "rain" plot.
* `boxPlotSymbolSize` - *Optional*, default value `8px`.
Size of symbols on the box plot.
* `colorsList` - *Optional*, default value is empty.
List of colours for plotting.
Empty indicates that the default list will be used.
* `monochrome` - *Optional*, default value `0`.
Indicates if the default list of colours should be gray-scale.
* `antialiasMax` - *Optional*, default value is empty.
Sets a value to the ODS graphics `ANTIALIASMAX` option.
When empty the value is calculated from data.
* `title` - *Optional*, default value - see notes below.
Provides a list of titles printed on the plot.
For details see notes below.
* `footnote` - *Optional*, default value - see notes below.
Provides a list of titles printed on the plot.
For details see notes below.
* `catLabels` - *Optional*, default value is empty.
List of values for group axix labels (vertical).
When empty a grouping variable name is used.
For details see notes below.
* `xLabels` - *Optional*, default value is empty.
List of values for data variable axix labels (horizontal).
When empty a data variable name is used.
For details see notes below.
* `catLabelPos` - *Optional*, default value `DATACENTER`.
Indicates position of the label on group axix (vertical).
Allowed values are `BOTTOM`, `CENTER`, `DATACENTER`, and `TOP`.
* `xLabelPos` - *Optional*, default value `DATACENTER`.
Indicates position of the label on data axix (horizontal).
Allowed values are `LEFT`, `CENTER`, `DATACENTER`, and `RIGHT`.
* `formated` - *Optional*, default value `0`.
Indicates if values of the grouping variable should be formated.
* `y2axis` - *Optional*, default value `1`.
Indicates if the righ vertical axix should be displayed.
* `y2axisLevels` - *Optional*, default value `4`.
Indicates if the number of expected levels of values printed
on the right vertical axix.
* `y2axisValueAttrs` - *Optional*, default value `Color=Grey`.
Allows to modify Y2 axis values attributes.
* `xaxisValueAttrs` - *Optional*, default value `Color=Grey`.
Allows to modify X axis values attributes.
* `xaxisTickstyle` - *Optional*, default value `INSIDE`.
Allows to modify X axis tick style.
Allowed values are `OUTSIDE`, `INSIDE`, `ACROSS`, and `INBETWEEN`.
*For SAS previous to* **9.4M5** *set to missing!*
***Stat related options***:
* `VSCALE` - *Optional*, default value `Proportion`.
Specifies the scale of the vertical axis.
Allowed values are `PROPORTION`, `PERCENT`, and `COUNT`.
`PROPORTION` scales the data in units of proportion of observations per data unit.
`PERCENT` scales the data in units of percent of observations per data unit.
`COUNT` scales the data in units of the number of observations per data unit.
* `KERNEL_K` - *Optional*, default value `NORMAL`.
Specifies type of kernel function to compute kernel density estimates.
Allowed values are `NORMAL`, `QUADRATIC`, and `TRIANGULAR`.
* `KERNEL_C` - *Optional*, default value `1`.
Specifies standardized bandwidth parameter *C* to compute kernel density estimates.
Allowed values are between `0` and `1`,
***Other options***:
* `cleanTempData` - *Optional*, default value `1`.
Indicates if temporary data sets should be deleted.
---
### NOTES: ###################################################################
* Default value of the `title` option is:
`%nrstr(title1 JUSTIFY=C "Rain Cloud plot for &list_g. by " %unquote(&xLabel.);)`
Use the `%str()` or `%nrstr()` macro-function to handle special characters.
The `%unquote()` is used when resolving the parameter.
* Default value of the `footnote` option is:
`%nrstr(footnote1 JUSTIFY=L COLOR=lightGray HEIGHT=1 "by RainCloudPlot macro from the BasePlus package";)`
Use the `%str()` or `%nrstr()` macro-function to handle special characters.
The `%unquote()` is used when resolving the parameter.
* The `catLabels` and `xLabels` should be quoted comma separated lists enclosed with brackets,
e.g. `catLabels=("Continent of Origin", "Car Type")`, see Example below.
* Kernel density estimates and basic statistics are calculated with `PROC UNIVARIATE`.
* Plot is generated by `PROC SGPLOT` with `BAND`, `SCATTE`, and `POLYGON` plots.
* After execution the ODS graphics dimension parameters are set to `800px` by `600px`.
* SAS notes (`NOTE:`) are disabled for the execution time.
* List of predefined colours is:
`BlueViolet`, `RoyalBlue`, `OliveDrab`, `Gold`, `HotPink`, `Crimson`,
`MediumPurple`, `CornflowerBlue`, `YellowGreen`, `Goldenrod`, `Orchid`, `IndianRed`.
### BOX-AND-WHISKERS PLOT: ###################################################################
The box-and-whiskers plot has the following interpretation:
- left vertical bar indicates the minimum,
- left whisker line starts at `max(Q1 - 1.5IQR, minimum)` and ends at lower quartile (Q1),
- diamond indicates mean,
- vertical bar inside of the box indicates median,
- right whisker line starts at upper quartile (Q3) and ends at `min(Q3 + 1.5IQR, maximum)`,
- right vertical bar indicates the maximum.
With above setup it may happen that
there is a gap between the minimum marker and the beginning of the left whisker
or
there is a gap between the end of the right whisker and the maximum marker.
See examples below.
---
### EXAMPLES AND USECASES: ####################################################
**EXAMPLE 1.** Simple Rain Cloud Plot for a `have` dataset:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
data have;
g = "Aaa";
do _N_ = 1 to 50;
x = rannor(42);
output;
end;
g = "Bb";
do _N_ = 1 to 120;
select (mod(_N_,9));
when(1,2,3,4,5) x = 0.5*rannor(42)+1;
when(6,7,8) x = 0.5*rannor(42)+3;
otherwise x = 0.5*rannor(42)+5;
end;
output;
end;
g = "C";
do _N_ = 1 to 60;
x = 3*rannor(42)+7;
output;
end;
run;
%RainCloudPlot(have, g, x)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The output:
![Example 1](./baseplus_RainCloudPlot_Ex1.png)
**EXAMPLE 2.** Rain Cloud plot for `sashelp.cars` dataset
with groups by Origin or Type
for Invoice variables:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%RainCloudPlot(
sashelp.cars(where=(Type ne "Hybrid"))
, Origin Type
, Invoice
, HeightPX=300
, y2axisLevels=3
, catLabels=("Continent of Origin", "Car Type")
, xLabels="Invoice, [$]"
)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The output:
![Example 2a](./baseplus_RainCloudPlot_Ex2a.png)
![Example 2b](./baseplus_RainCloudPlot_Ex2b.png)
---
## >>> `%zipLibrary()` macro: <<< <a name="ziplibrary-macro"></a> #######################
The zipLibrary() macro allows to zip content of a SAS library.
Files can be zipped into a single file (named as the input library)
or into multiple files (named as "dataset.sas7bdat.zip").
If a file is indexed also the index file is zipped.
Source files can be deleted after compression.
Status of compression and processing time is reported.
See examples below for the details.
### SYNTAX: ###################################################################
The basic syntax is the following, the `<...>` means optional parameters:
~~~~~~~~~~~~~~~~~~~~~~~sas
%zipLibrary(
lib
<,mode=>
<,clean=>
<,libOut=>
<,compression=>
)
~~~~~~~~~~~~~~~~~~~~~~~
**Arguments description**:
1. `lib` - *Required*, a name of the library to be zipped.
Must be a valid SAS V7, V8, or V9 library.
* `mode = S` - *Optional*, default value is `S`,
indicates mode of compression
generates single zip file (`SINGLE/S`)
or multiple files (`MULTI/M`)
* `clean = 0` - *Optional*, default value is `0`,
should datasets be deleted after zipping?
`1` means *yes*, `0` means *no*.
* `libOut =` - *Optional*, default value is empty,
output library for a single zip file.
* `compression =` - *Optional*, default value is `6`,
specifies the compression level
`0` to `9`, where `0` is no compression
and `9` is maximum compression.
### EXAMPLES AND USECASES: ####################################################
**EXAMPLE 1.** Generate data:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
options dlcreatedir;
libname test1 "%sysfunc(pathname(work))/test1";
libname test2 "%sysfunc(pathname(work))/test2";
libname test3 (test1 test2);
libname test4 "%sysfunc(pathname(work))/test4";
options nodlcreatedir;
%put %sysfunc(pathname(test3));
%put %sysfunc(pathname(test4));
data
test1.A(index=(model))
test1.B
test2.C
test2.D(index=(model make io=(invoice origin)))
;
set sashelp.cars;
run;
data test1.B2 / view=test1.B2;
set test1.B;
output;
output;
run;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**EXAMPLE 2.** Zip content of test3 library
into the same location in one zip file:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%zipLibrary(test3)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**EXAMPLE 3.** Zip content of test3 library
into the same location in multiple zip files:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%zipLibrary(test3, mode=MULTI)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**EXAMPLE 4.** Zip content of test3 library
with maximum compression level
into different location in one zip file
and delete source files:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%zipLibrary(test3, clean=1, libOut=test4, compression=9)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---
## >>> `%unzipLibrary()` macro: <<< <a name="unziplibrary-macro"></a> #######################
The unzipLibrary() macro allows to unzip content of a SAS library.
It is a *counterpart* to the `%zipLibrary()` macro and is *not* intended to work
with zip files generated by other software (though it may in some cases).
Files can be unzipped from a single file
or from multiple files (named e.g. "dataset.sas7bdat.zip").
If a file is indexed also the index file is unzipped.
Source files can be deleted after decompression.
Status of decompression and processing time is reported.
See examples below for the details.
### SYNTAX: ###################################################################
The basic syntax is the following, the `<...>` means optional parameters:
~~~~~~~~~~~~~~~~~~~~~~~sas
%unzipLibrary(
path
<,zip=>
<,mode=>
<,clean=>
<,libOut=>
)
~~~~~~~~~~~~~~~~~~~~~~~
**Arguments description**:
1. `path` - *Required*, a path pointing to zipped file(s) location.
* `zip =` - *Optional*, When `mode=S` a name of the
zip file containing SAS files to be unzipped.
* `mode = S` - *Optional*, default value is `S`,
indicates mode of decompression
read from a single zip file (`SINGLE/S`)
or from multiple files (`MULTI/M`)
* `clean = 0` - *Optional*, default value is `0`,
should zip files be deleted after unzipping?
`1` means *yes*, `0` means *no*.
* `libOut =` - *Optional*, default value is empty,
output library for a single zip file
decompression.
### EXAMPLES AND USECASES: ####################################################
**EXAMPLE 1.** Generate data:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
options dlcreatedir;
libname test1 "%sysfunc(pathname(work))/test1";
libname test2 "%sysfunc(pathname(work))/test2";
libname test3 (test1 test2);
libname test4 "%sysfunc(pathname(work))/test4";
options nodlcreatedir;
%put %sysfunc(pathname(test3));
%put %sysfunc(pathname(test4));
data
test1.A(index=(model))
test1.B
test2.C
test2.D(index=(model make io=(invoice origin)))
;
set sashelp.cars;
run;
data test1.B2 / view=test1.B2;
set test1.B;
output;
output;
run;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**EXAMPLE 2.** Use data from Example 1.
First zip content of the `test3` library
to `test4` location into one zip file
and delete source files.
Next unzip `test3.zip` library into the
`test4` location and delete the zip file.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%zipLibrary(test3, clean=1, libOut=test4)
%unzipLibrary(%sysfunc(pathname(test4)), zip=test3, clean=1)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**EXAMPLE 3.** Use data from Example 1.
First zip content of the `test1` library
into multiple zip files and delete source files.
Next unzip `*.zip` files in `test1`
location and delete zipped files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%zipLibrary(test1, mode=M, clean=1)
%unzipLibrary(%sysfunc(pathname(test1)), mode=M, clean=1)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**EXAMPLE 4.** First zip content of the `sashelp` library
into `work` library.
Next unzip `sashelp.zip` file in `work`
location and delete zip file.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%zipLibrary(sashelp, mode=S, clean=0, libOut=work)
%unzipLibrary(%sysfunc(pathname(work)), zip=sashelp, mode=S, clean=1)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---
## License ####################################################################

Binary file not shown.

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

View File

@@ -6,6 +6,11 @@
* [`%createDHOrdStack()` macro](#createdhordstack-macro)
* [`%createDHPrtQueue()` macro](#createdhprtqueue-macro)
* [`%createDHStack()` macro](#createdhstack-macro)
* [`bit64orPROTOdfa()` proto function](#bit64orprotodfa-proto-function)
* [`bit64andPROTOdfa()` proto function](#bit64andprotodfa-proto-function)
* [`bit64orDFA()` subroutine](#bit64ordfa-function)
* [`bit64andDFA()` subroutine](#bit64anddfa-function)
* [`%createDFBitmap()` macro](#createdfbitmap-macro)
* [`generateArrays` exec](#createdhprtqueue-exec)
* [`generateArrays` clean](#createdhprtqueue-clean)
@@ -13,14 +18,15 @@
---
# The DFA package [ver. 0.3] <a name="dfa-package"></a> ###############################################
# The DFA package [ver. 0.5] <a name="dfa-package"></a> ###############################################
The **DFA** (a.k.a. *Dynamic Function Array*) package implements:
- dynamic numeric and character arrays,
- dynamic stacks (filo),
- dynamic queues (fifo),
- dynamic ordered stacks,
- priority queues.
- priority queues,
- bitmap.
The package provides a set of *macros*,
which allows to *generate* `call routines`
@@ -32,19 +38,24 @@ See particular macro help for further details.
---
Package contains:
1. macro createdfarray
2. macro createdharray
3. macro createdhfifo
4. macro createdhordstack
5. macro createdhprtqueue
6. macro createdhstack
7. exec generatearrays
8. clean generatearrays
1. macro createdfarray
2. macro createdharray
3. macro createdhfifo
4. macro createdhordstack
5. macro createdhprtqueue
6. macro createdhstack
7. proto bit64andprotodfa
8. proto bit64orprotodfa
9. functions bit64anddfa
10. functions bit64ordfa
11. macro createdfbitmap
12. exec generatearrays
13. clean generatearrays
*SAS package generated by generatePackage, version 20201115*
*SAS package generated by generatePackage, version 20211111*
The SHA256 hash digest for package BasePlus:
`1FC8D030D576C33F1B5DEB27E17534946209BC148D57A1357CA025ED1E69AEB8`
`C32A81304A411C1EB6BA7B76EDB8D70550F3935F35A1506E2B8019A2036FB5FF`
---
# Content description ############################################################################################
@@ -70,6 +81,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
<,resizeFactor=0>
<,outlib=work.DFAfcmp.package>
<,hashexp=13>
<,header=1>
)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -107,6 +119,10 @@ The basic syntax is the following, the `<...>` means optional parameters:
* `hashexp=` - *Optional*, the default value is `13`. It is the default `hashexp=`
value for internal hash table used by the function.
* `header=` - *Optional*, the default value is `1`. Indicates if
the `proc fcmp outlib = &outlib.;` header is added to
the executed code. If not 1 then no header is added.
**Created function arguments description**:
A function generated by the macro is:
@@ -312,6 +328,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
<,type=8>
<,outlib=work.DFAfcmp.package>
<,hashexp=13>
<,header=1>
)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -340,6 +357,10 @@ The basic syntax is the following, the `<...>` means optional parameters:
* `hashexp=` - *Optional*, the default value is `13`. It is the default `hashexp=`
value for internal hash table used by the function.
* `header=` - *Optional*, the default value is `1`. Indicates if
the `proc fcmp outlib = &outlib.;` header is added to
the executed code. If not 1 then no header is added.
**Created function arguments description**:
A function generated by the macro is:
@@ -466,6 +487,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
<,type=8>
<,outlib=work.DFAfcmp.package>
<,hashexp=13>
<,header=1>
)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -494,6 +516,10 @@ The basic syntax is the following, the `<...>` means optional parameters:
* `hashexp=` - *Optional*, the default value is `13`. It is the default `hashexp=`
value for internal hash table used by the function.
* `header=` - *Optional*, the default value is `1`. Indicates if
the `proc fcmp outlib = &outlib.;` header is added to
the executed code. If not 1 then no header is added.
**Created function arguments description**:
A function generated by the macro is:
@@ -637,6 +663,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
<,order=A>
<,outlib=work.DFAfcmp.package>
<,hashexp=13>
<,header=1>
)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -669,7 +696,10 @@ The basic syntax is the following, the `<...>` means optional parameters:
* `hashexp=` - *Optional*, the default value is `13`. It is the default `hashexp=`
value for internal hash table used by the function.
* `header=` - *Optional*, the default value is `1`. Indicates if
the `proc fcmp outlib = &outlib.;` header is added to
the executed code. If not 1 then no header is added.
**Created function arguments description**:
A function generated by the macro is:
@@ -793,6 +823,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
<,newOnTop=+>
<,outlib=work.DFAfcmp.package>
<,hashexp=13>
<,header=1>
)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -826,7 +857,10 @@ The basic syntax is the following, the `<...>` means optional parameters:
* `hashexp=` - *Optional*, the default value is `13`. It is the default `hashexp=`
value for internal hash table used by the function.
* `header=` - *Optional*, the default value is `1`. Indicates if
the `proc fcmp outlib = &outlib.;` header is added to
the executed code. If not 1 then no header is added.
**Created function arguments description**:
A function generated by the macro is:
@@ -954,6 +988,7 @@ The basic syntax is the following, the `<...>` means optional parameters:
<,type=8>
<,outlib=work.DFAfcmp.package>
<,hashexp=13>
<,header=1>
)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -982,7 +1017,10 @@ The basic syntax is the following, the `<...>` means optional parameters:
* `hashexp=` - *Optional*, the default value is `13`. It is the default `hashexp=`
value for internal hash table used by the function.
* `header=` - *Optional*, the default value is `1`. Indicates if
the `proc fcmp outlib = &outlib.;` header is added to
the executed code. If not 1 then no header is added.
**Created function arguments description**:
A function generated by the macro is:
@@ -1089,6 +1127,413 @@ The `value` argument is **outarg**, i.e. can be changed by the function.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---
## >>> `bit64orPROTOdfa()` proto function: <<< <a name="bit64orprotodfa-proto-function"></a> #######################
The **bit64orPROTOdfa()** is external *C* function,
this is the implementation of the *bitwise OR* operation
on doubles. A double is returned.
**Caution!** For SAS numeric values *only* operations on first 53 bits are valid!
The function is used **internally** by functions in the *DFA* package.
### SYNTAX: ###################################################################
The basic syntax is the following:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
bit64orPROTOdfa(i, j)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Arguments description**:
1. `i` - A double numeric argument.
2. `j` - A double numeric argument.
---
## >>> `bit64andPROTOdfa()` proto function: <<< <a name="bit64andprotodfa-proto-function"></a> #######################
The **bit64andPROTOdfa()** is external *C* function,
this is the implementation of the *bitwise AND* operation
on doubles. A double is returned.
**Caution!** For SAS numeric values *only* operations on first 53 bits are valid!
The function is used **internally** by functions in the *DFA* package.
### SYNTAX: ###################################################################
The basic syntax is the following:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
bit64andPROTOdfa(i, j)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Arguments description**:
1. `i` - A double numeric argument.
2. `j` - A double numeric argument.
---
## >>> `bit64orDFA()` subroutine: <<< <a name="bit64ordfa-function"></a> #######################
The **bit64orDFA()** function is an alternative to
the 32 bit bitwise `BOR()` function working on SAS numerics.
Allows to work on *up to* 53 bits of SAS numeric value.
The `bit64orDFA()` is an *internal* function of the `DFA` package.
### SYNTAX: ###################################################################
The basic syntax is the following, the `<...>` means optional parameters:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
bit64orDFA(a, b)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Arguments description**:
1. `a` - Argument is a SAS numeric values.
2. `B` - Argument is a SAS numeric values.
### EXAMPLES AND USECASES: ####################################################
**EXAMPLE 1.** Basic test of `bit64orDFA()` and `bit64andDFA()`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
options ls = max ps = max;
%let M = 53 ; %* 53 is maximum valid value;
data _null_;
array bitmask [ 0: &M] _temporary_ ;
do P = 1 to &M ;
bitmask[P] = 2**(P-1) ;
put bitmask[P] = binary54. @;
put bitmask[P] = best32.;
end ;
bitmask[0] = bitmask[&M.] ;
put bitmask[0] = best32. /;
a=0;
put a = binary54.;
do P = 1 to &M ;
a = BIT64ORDFA (a, bitmask[P]) ;
put a = binary54.;
end;
put;
b = 0;
put b = binary54./;
do P = 1 to &M ;
b + (BIT64ANDDFA (a, bitmask[P]) ne .) ;
put b = best32.;
end;
run;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---
## >>> `bit64andDFA()` subroutine: <<< <a name="bit64anddfa-function"></a> #######################
The **bit64andDFA()** function is an alternative to
the 32 bit bitwise `BAND()` function working on SAS numerics.
Allows to work on *up to* 53 bits of SAS numeric value.
The `bit64andDFA()` is an *internal* function of the `DFA` package.
### SYNTAX: ###################################################################
The basic syntax is the following, the `<...>` means optional parameters:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
bit64andDFA(a, b)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Arguments description**:
1. `a` - Argument is a SAS numeric values.
2. `B` - Argument is a SAS numeric values.
### EXAMPLES AND USECASES: ####################################################
**EXAMPLE 1.** Basic test of `bit64orDFA()` and `bit64andDFA()`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
options ls = max ps = max;
%let M = 53 ; %* 53 is maximum valid value;
data _null_;
array bitmask [ 0: &M] _temporary_ ;
do P = 1 to &M ;
bitmask[P] = 2**(P-1) ;
put bitmask[P] = binary54. @;
put bitmask[P] = best32.;
end ;
bitmask[0] = bitmask[&M.] ;
put bitmask[0] = best32. /;
a=0;
put a = binary54.;
do P = 1 to &M ;
a = BIT64ORDFA (a, bitmask[P]) ;
put a = binary54.;
end;
put;
b = 0;
put b = binary54./;
do P = 1 to &M ;
b + (BIT64ANDDFA (a, bitmask[P]) ne .) ;
put b = best32.;
end;
run;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---
## >>> `%createDFBitmap()` macro: <<< <a name="createdfbitmap-macro"></a> #######################
The `%createDFBitmap()` macro allows to generate
a `dynamic function bitmap` which is a FCMP based
approach to create *dynamically* allocated **numeric**
bitmnap.
*Note:* Arrays provided by the macro are *one dimensional* arrays.
The idea of a SAS bitmap is based on:
1. SGF Paper 3101-2019
titeled **Re-Mapping A Bitmap** by *Paul M. Dorfman* and *Lessia S. Shajenko*
[https://www.sas.com/content/dam/SAS/support/en/sas-global-forum-proceedings/2019/3101-2019.pdf](https://www.sas.com/content/dam/SAS/support/en/sas-global-forum-proceedings/2019/3101-2019.pdf)
2. SUGI Paper 8-26
titeled **Table Look-Up by Direct Addressing: Key-Indexing -- Bitmapping -- Hashing** by *Paul M. Dorfman*
[https://support.sas.com/resources/papers/proceedings/proceedings/sugi26/p008-26.pdf](https://support.sas.com/resources/papers/proceedings/proceedings/sugi26/p008-26.pdf)
### SYNTAX: ###################################################################
The basic syntax is the following, the `<...>` means optional parameters:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%createDFBitmap(
bitmapName
<,debug=0>
<,outlib=work.DFAfcmp.package>
<,type=32>
<,header=1>
)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Arguments description**:
1. `bitmapName` - *Required*, creates a FCMP call subroutine which is also
a bitmap name. In the data step it is used in form of
a call subroutine, e.g. `call bitmapName("Allocate", 3000)`.
Has to satisfy FCMP function naming requirements, but with
maximum of 24 characters.
* `debug=` - *Optional*, the default value is `0`.
If set to `1` then it turns on a debugging mode.
* `outlib=` - *Optional*, the default value is `work.DFAfcmp.package`.
It points the default location for new generated dynamic
function arrays compiled by FCMP.
*Hint!* Keep it as it is.
* `type=` - *Optional*, the default value is `32`. Sets the type of
bitwise operations executed internaly on the bitmap.
The only valid values are `32` or `52`,
With 32 the `BOR()` and `BAND()` SAS functions are used
and with 52 the `bit64orDFA()` and `bit64and DFA()` FCMP
functions are used.
* `header=` - *Optional*, the default value is `1`. Indicates if
the `proc fcmp outlib = &outlib.;` header is added to
the executed code. If not 1 then no header is added.
**Created function arguments description**:
A function generated by the macro is:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
call &bitmapName.(IO, position, value)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
and accepts the following list of arguments and values:
1. `IO` - is a *character* steering argument, possible
values and behaviour they call are the following:
- `Check`, `Test`, `T` - to get information if a bit is set to 1 (on) or not,
- `On`, `1` - to set a selected bit to 1,
- `Off`, `0` - to set a selected bit to 0,
- `C`, `Clear` - to reduce a bitmat to a single empty cell,
- `A`, `Allocate` - to reserve space for a bitmap and set all bits to 0,
- `A0`, `Allocate0` - to reserve space for a bitmap and set all bits to 0,
- `A1`, `Allocate1` - to reserve space for a bitmap and set all bits to 1,
- `D`, `Dim`, `Dimension` - to returns minimal and maximal index of the bitmap.
2. `position` - is a *numeric* argument and depends on the `IO` value.
Behaves in the following way:
- for `On`, `Off`, `1`, `0`/ `Check`, `Test`, `T` it is a bitmap index,
- for `C`, `Clear` is ignored,
- for `A`, `Allocate` sets the value of the minposition, i.e. the minimal position of the bitmap index,
- for `D`, `Dimension` it returns value of the minposition,
.3 `value` - is a *numeric* argument and depends on the `IO` value.
Behaves in the following way:
- for `Check`, `Test`, `T` it holds value retrieved from a bitmap on a given position,
- for `On`, `Off`, `1`, `0`, `C`, `Clear` is ignored,
- for `A`, `Allocate` it sets the value of the maxposition, i.e. maximal position of the array index,
- for `D`, `Dimension` it returns value of the maxposition
The `position` and the `value` arguments are **outargs**, i.e. can be changed by the function.
### EXAMPLES AND USECASES: ####################################################
**EXAMPLE 1.** Bitmap of type 32:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%createDFBitmap(MyBitmap32,type=32,debug=1);
options APPEND=(cmplib = WORK.DFAfcmp) ;
data Example1;
call MyBitmap32("Allocate", -10, 100);
L = 0; H = 0;
call MyBitmap32("Dim", L, H);
put L= H=;
* populate array with data ;
do i = L to H by 2;
put i @;
call MyBitmap32("1", i, .);
end;
put;
* get values from the array ;
Value = .;
do i = L to H;
call MyBitmap32("T", i, Value);
put i= Value=;
end;
run;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**EXAMPLE 2.** Bitmap of type 52:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%createDFBitmap(MyBitmap52,type=52,debug=1);
options APPEND=(cmplib = WORK.DFAfcmp) ;
data Example2;
call MyBitmap52("Allocate", -10, 100);
L = 0; H = 0;
call MyBitmap52("Dim", L, H);
put L= H=;
* populate array with data ;
do i = L to H by 2;
put i @;
call MyBitmap52("1", i, .);
end;
put;
* get values from the array ;
Value = .;
do i = L to H;
call MyBitmap52("T", i, Value);
put i= Value=;
end;
run;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**EXAMPLE 3.** Execution time test for type 52:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%createDFBitmap(MyBigBitmap52,type=52,debug=0);
options FULLSTIMER APPEND=(cmplib = WORK.DFAfcmp) ;
data Example3;
call MyBigBitmap52("Allocate", -10, 2000000001);
L = 0; H = 0;
call MyBigBitmap52("Dim", L, H);
put L= H=;
* populate bitmap with data ;
t = time();
do i = L to H by 17;
call MyBigBitmap52("1", i, .);
x + 1;
end;
t = time() - t;
put "populate:" t= x=;
* get values from the bitmap ;
t = time();
Value = .;
do i = L to H;
call MyBigBitmap52("T", i, Value);
x + (-Value);
end;
t = time() - t;
put "search:" t= x=;
run;
%*
L=-10 H=2000000001
populate:t=55.902999878 x=117647060
search:t=654.12900019 x=0
NOTE: The data set WORK.EXAMPLE3 has 1 observations and 6 variables.
NOTE: DATA statement used (Total process time):
real time 11:50.42
user cpu time 11:46.40
system cpu time 0.45 seconds
memory 301791.12k
OS Memory 326332.00k
;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**EXAMPLE 4.** Execution time test for type 32:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%createDFBitmap(MyBigBitmap32,type=32,debug=0);
options FULLSTIMER APPEND=(cmplib = WORK.DFAfcmp) ;
data Example4;
call MyBigBitmap32("Allocate", -10, 2000000001);
L = 0; H = 0;
call MyBigBitmap32("Dim", L, H);
put L= H=;
* populate bitmap with data ;
t = time();
do i = L to H by 17;
call MyBigBitmap32("1", i, .);
x + 1;
end;
t = time() - t;
put "populate:" t= x=;
* get values from the bitmap ;
t = time();
Value = .;
do i = L to H;
call MyBigBitmap32("T", i, Value);
x + (-Value);
end;
t = time() - t;
put "populate:" t= x=;
run;
%*
L=-10 H=2000000001
populate:t=50.417999983 x=117647060
populate:t=611.13600016 x=0
NOTE: The data set WORK.EXAMPLE4 has 1 observations and 6 variables.
NOTE: DATA statement used (Total process time):
real time 11:02.07
user cpu time 10:59.07
system cpu time 1.46 seconds
memory 489583.90k
OS Memory 513876.00k
;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---
## >>> `generateArrays` exec: <<< <a name="createdhprtqueue-exec"></a> #######################
The generateArrays exec file provides a **list of automatically generated examples** of functions
@@ -1112,6 +1557,8 @@ The list of provided examples is the following:
- `PrtQueueNBC` - Dynamic Hash-based Character Priority Queue with *New on Bottom* (length 256 bytes)
- `PrtQueueNTN` - Dynamic Hash-based Numeric Priority Queue with *New on Top*
- `PrtQueueNBN` - Dynamic Hash-based Numeric Priority Queue with *New on Bottom*
- `Bitmap32` - Dynamic Function Bitmap on 32 bit
- `Bitmap52` - Dynamic Function Bitmap on 52 bit
The `outlib=` option is set to `work.DFAfcmp.package`. The `cmplib=` option is updated automatically.

Binary file not shown.

Binary file not shown.

280
packages/gsm.md Normal file
View File

@@ -0,0 +1,280 @@
- [The GSM package](#gsm-package)
- [Content description](#content-description)
* [`%GSM()` macro](#gsm-macro)
* [`%GSMpck_makeFCMPcode()` macro](#gsmpck-makefcmpcode-macro)
* [License](#license)
---
# The GSM package [ver. 0.17] <a name="gsm-package"></a> ###############################################
The **GSM** (a.k.a. *Generate Secure Macros*) package allows
to create secured macros stored in SAS Proc FCMP functions.
The dataset with functions can be shared and allows to generate
macros without showing their code.
The GSM package is basically an automated version of the following:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
proc fcmp outlib = work.gsm.secure ENCRYPT;
function generateMacro() $;
rc = RESOLVE('
%macro secretMacro(x) / SECURE;
data test;
a = "&x.";
run;
%mend;
');
return (rc);
endsub;
run;
/* share work.gsm dataset */
options cmplib = work.gsm;
data _null_;
rc = generateMacro();
put rc=;
run;
/* enjoy */
%secretMacro(42)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
See examples for more details.
*How to use it:*
- Copy all files with your secured macros code into a directory.
Best approach is to have one file for one macro.
- Copy a path to the directory.
- Run the following code:
```
%GSM(<the path to directory>, cmplib=<name of the dataset>)
```
- Share generated `ZIP` file (unzip and run the code).
*Limitations:*
Single macro file cannot be longer than 32760 bytes.
---
Package contains:
1. macro gsm
2. macro gsmpck_makefcmpcode
Required SAS Components:
`Base SAS Software`
* SAS package generated by generatePackage, version 20211111 *
The SHA256 hash digest for package GSM:
`F6EE77A3C042E1E083E970BE255D126B52A75205DC1FB9A4A7337D0A89EEC7EB`
## >>> `%GSM()` macro: <<< <a name="gsm-macro"></a> #######################
The `%GSM()` macro is the main macro of
the **GSM** (a.k.a. *Generate Secure Macros*) package.
It converts a list of macros provided by the user into
a data set of the Proc FCMP functions. The macros are stored
in functions are encrypted which allow to share them without
showing their code. *Important* thing is that macros provided
by the user *has* to be "secure", i.e. the `secure` option has to
be added to the macro definition. See the example:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%macro secretMacro(x) / SECURE; /* <- the secure option */
<... some code ...>
%mend secretMacro;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
As a result a zip file, containing dataset with functions and
code to be executed on site, is generated.
Since encrypted code is stored in a SAS dataset it has
no limitation in sharing between operating systems (like catalogs have).
*Limitation:* Due to the `Resolve()` function limitations
a single macro file cannot be longer than 32760 bytes.
*Notes:*
- All macros have to have the `secure` option added, i.e. `%macro aMacroname(...) / SECURE ;`.
- During the execution a test macro, named `%GSMpck_dummyMacroForTests()`, is generated.
- The `%GSM()` macro calls the `%GSMpck_makeFCMPcode(...)` macro internally.
### SYNTAX: ###################################################################
The basic syntax is the following, the `<...>` means optional parameters:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%GSM(
path
<,trim=0>
<,cmplib=work.generateMacros>
<,source2=>
<,outpath=>
<,encodingRestricted=>
<,secret=>
)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Arguments description**:
1. `path` - *Required*, indicates a directory which contains files with macros.
Only files with `sas` extension are used.
* `trim=` - *Optional*, the default value is `0`.
If set to `1` then lines of macro code are trimmed.
If set to `2` then lines of macro code are stripped.
* `cmplib=` - *Optional*, the default value is `work.generateMacros`.
Names the dataset which will contain generated functions.
* `source2=` - *Optional*, the default value is null.
Indicate if `%includ`-ed files are printed out.
Any value other than null enables printing.
* `outpath=` - *Optional*, the default value is set the same as the `path`.
Points a directory in which a result (a zip file) is generated.
* `encodingRestricted=` - *Optional*, the default value is `0`.
If set to 1 then if User session encoding is different from
encoding of the session which generates the dataset then
the generateMacros() function will not execute macro code.
* `secret=` - *Optional*, the default value is null, in such case the
secret is generated from the `sha256(datetime(), hex32.)` function
and is printed in the log. When not null then should be
alphanumerical constant. Non-alphanumerical characters are removed.
Required to execute the `resolve()` function.
User who do not know the value will not be able
to run the `_maxro_XX_()` function.
---
### Example: ###################################################################
Example 1. Prepare 2 files: `f1.sas` and `f2.sas` and use the `%GSM()` macro.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%let path = %sysfunc(pathname(work))/path2files;
%put &=path.;
options dlcreatedir;
libname path "&path.";
filename path "&path.";
data _null_;
file path(f1.sas);
input;
put _infile_;
cards4;
%macro abc(x) / SECURE;
data test;
do i = 1 to &x.;
put i=;
end;
run;
%mend;
;;;;
run;
data _null_;
file path(f2.sas);
input;
put _infile_;
cards4;
%macro xyz(x) / SECURE;
%do i = 1 %to &x.;
%put &=i;
%end;
%mend;
;;;;
run;
%GSM(&path., cmplib=work.myMacros)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## >>> `%GSMpck_makeFCMPcode()` macro: <<< <a name="gsmpck-makefcmpcode-macro"></a> #######################
The `%GSMpck_makeFCMPcode()` macro is an internal macro of
the **GSM** (a.k.a. *Generate Secure Macros*) package.
It executes a process of converting
a macro provided by the user into
a Proc FCMP function.
Since encrypted code is stored in a SAS dataset it has
no limitation in sharing between operating systems (like catalogs have).
*Limitation:* Single macro file cannot be longer than 32760 bytes.
### SYNTAX: ###################################################################
The basic syntax is the following, the `<...>` means optional parameters:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
%GSMpck_makeFCMPcode(
path
,number
<,trim=0>
<,outlib=work.generateMacros.secure>
<,source2=>
<,fileNameCode=FNC>
<,secret=123456789>
)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Arguments description**:
1. `path` - *Required*, indicates a directory which contains files with macros.
Only files with `sas` extension are used.
2. `number` - *Required*, a sequential number.
* `trim=` - *Optional*, the default value is `0`.
If set to `1` then lines of macro code are trimmed.
If set to `2` then lines of macro code are stripped.
* `cmplib=` - *Optional*, the default value is `work.generateMacros`.
Names the dataset which will contain generated functions.
* `source2=` - *Optional*, the default value is null.
Indicate if `%includ`-ed files are printed out.
Any value other than null enables printing.
* `fileNameCode=` - *Optional*, the default value is `FNC`.
Internal fileref.
* `secret=` - *Optional*, internal, the default value is `1234567890`.
Alphanumerical constant required to execute the `resolve()`
function. User who do not know the value will not be able
to run the `_maxro_XX_()` function.
---
## License ####################################################################
Copyright (c) Bartosz Jablonski, since 2021
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
---

BIN
packages/gsm.zip Normal file

Binary file not shown.

View File

@@ -66,10 +66,10 @@ Package contains:
Required SAS Components:
*Base SAS Software*
*SAS package generated by generatePackage, version 20201115.*
*SAS package generated by generatePackage, version 20211111.*
The SHA256 hash digest for package macroArray:
`AC3AD58AFBBE459616743DC6346330BD8DD33FBA8CDD595423F181B67D0475BC`
`70032D27081A0EE15BC82B8F14D2A61700FA7C1F0D88B4DB516AB433CD06C4D3`
---
# Content description ############################################################################################

Binary file not shown.

View File

@@ -46,10 +46,10 @@ Package contains:
Required SAS Components:
*Base SAS Software*
*SAS package generated by generatePackage, version 20201115*
*SAS package generated by generatePackage, version 20211111*
The SHA256 hash digest for package SQLinDS:
`CE1A266B9030E5E336B45F53DF483F6913FD8AE88A2884CEE88BEEF621FDBD78`
`F2BE3CC68C9A34DD324FD35C8287A4F89737E2E28E806E0DD7FB0EBF60F7C569`
---
# Content description ############################################################################################

Binary file not shown.