diff --git a/packages/README.md b/packages/README.md index e2e7267..5ed871d 100644 --- a/packages/README.md +++ b/packages/README.md @@ -61,7 +61,7 @@ SHA256 digest for DFA: F*012375D87F66EB3A7BF5DDD0CC5AEE28851733EE33CC63231DF9045 --- -- **macroArray**\[1.2.6\], implementation of an array concept in a macro language, e.g. +- **macroArray**\[1.3.0\], implementation of an array concept in a macro language, e.g. ```sas %array(ABC[17] (111:127), macarray=Y); @@ -80,7 +80,7 @@ SHA256 digest for DFA: F*012375D87F66EB3A7BF5DDD0CC5AEE28851733EE33CC63231DF9045 which = 1:H:2 ); ``` -SHA256 digest for macroArray: F*3F3893F1FCD78719543703E4353F4CC19811D247C016F220FF729B283C1AD790 +SHA256 digest for macroArray: F*9B51F1B434742F08166F28DE40D64F16E9BC5ED8D1926AE7148A48116F7BDBA0 [Documentation for macroArray](https://github.com/SASPAC/blob/main/macroarray.md "Documentation for macroArray") diff --git a/packages/SHA256_for_packages.txt b/packages/SHA256_for_packages.txt index e3963e7..121b036 100644 --- a/packages/SHA256_for_packages.txt +++ b/packages/SHA256_for_packages.txt @@ -1,3 +1,6 @@ +/* 20260113 */ +macroArray: F*9B51F1B434742F08166F28DE40D64F16E9BC5ED8D1926AE7148A48116F7BDBA0 + /* 20251122 */ SQLinDS: F*606A24A2A6B06DAAD2D443FA9A9819D9564235A5CD8599FD15586F1EFFCB41BC diff --git a/packages/macroarray.md b/packages/macroarray.md index 58b4192..c03acda 100644 --- a/packages/macroarray.md +++ b/packages/macroarray.md @@ -1,27 +1,36 @@ -- [The macroArray package](#macroarray) -- [Content description](#content-description) - * [`%appendArray()` macro](#appendarray-macro) - * [`%appendCell()` macro](#appendcell-macro) - * [`%array()` macro](#array-macro) - * [`%concatArrays()` macro](#concatarrays-macro) - * [`%deleteMacArray()` macro](#deletemacarray-macro) - * [`%do_over()` macro](#do-over-macro) - * [`%do_over2()` macro](#do-over2-macro) - * [`%do_over3()` macro](#do-over3-macro) - * [`%make_do_over()` macro](#make-do-over-macro) - * [`%mcHashTable()` macro](#mchashtable-macro) - * [`%mcDictionary()` macro](#mcdictionary-macro) - * [`%QzipArrays()` macro](#qziparrays-macro) - * [`%zipArrays()` macro](#ziparrays-macro) - * [`%sortMacroArray()` macro](#sortmacroarray-macro) +# Documentation for the `macroArray` package. + +---------------------------------------------------------------- + + *Macroarrays for macro codes* + +---------------------------------------------------------------- + +### Version information: + +- Package: macroArray +- Version: 1.3.0 +- Generated: 2026-01-13T14:47:32 +- Author(s): Bartosz Jablonski (yabwon@gmail.com) +- Maintainer(s): Bartosz Jablonski (yabwon@gmail.com) +- License: MIT +- File SHA256: `F*9B51F1B434742F08166F28DE40D64F16E9BC5ED8D1926AE7148A48116F7BDBA0` for this version +- Content SHA256: `C*BBE7D736D7DF66231C41EEE321E9FE8C50D174C6DC43AFC09F4990894A5E7CBD` for this version - * [License](#license) - --- + +# The `macroArray` package, version: `1.3.0`; + +--- + -# The macroArray package [ver. 1.2.6] ############################################### +The **macroArray** package implements a macroarray facility. -The **macroArray** package implements a macroarray facility: +The set of macros, which emulates classic +data-step-array functionality on the macro +programming level, is provided. + +Some of components are: - `%array()`, - `%do_over()`, - `%make_do_over()`, @@ -34,10 +43,6 @@ The **macroArray** package implements a macroarray facility: - `%mcDictionary()`, - etc. -The set of macros, which emulates classic -data-step-array functionality on the macro -programming level, is provided. - *Note:* If you are working with BIG macroarrays do not forget to verify your session setting for macro @@ -56,35 +61,51 @@ to verify the following options: --- -Package contains: - 1. macro appendarray - 2. macro appendcell - 3. macro array - 4. macro concatarrays - 5. macro deletemacarray - 6. macro do_over - 7. macro do_over2 - 8. macro do_over3 - 9. macro make_do_over - 10. macro mcdictionary - 11. macro mchashtable - 12. macro qziparrays - 13. macro sortmacroarray - 14. macro ziparrays - -Required SAS Components: - *Base SAS Software* - -*SAS package generated by generatePackage, version 20231123* - -The SHA256 hash digest for package macroArray: -`F*3F3893F1FCD78719543703E4353F4CC19811D247C016F220FF729B283C1AD790` - + --- -# Content description ############################################################################################ -## >>> `%appendArray()` macro: <<< ############ - + +--- + +Required SAS Components: + - Base SAS Software + +--- + + +--------------------------------------------------------------------- + +*SAS package generated by SAS Package Framework, version `20251231`,* +*under `WIN`(`X64_10PRO`) operating system,* +*using SAS release: `9.04.01M9P06042025`.* + +--------------------------------------------------------------------- + +# The `macroArray` package content +The `macroArray` package consists of the following content: + +1. [`%appendarray()` macro ](#appendarray-macro-1 ) +2. [`%appendcell()` macro ](#appendcell-macro-2 ) +3. [`%array()` macro ](#array-macro-3 ) +4. [`%concatarrays()` macro ](#concatarrays-macro-4 ) +5. [`%deletemacarray()` macro ](#deletemacarray-macro-5 ) +6. [`%do_over()` macro ](#doover-macro-6 ) +7. [`%do_over2()` macro ](#doover2-macro-7 ) +8. [`%do_over3()` macro ](#doover3-macro-8 ) +9. [`%make_do_over()` macro ](#makedoover-macro-9 ) +10. [`%mcdictionary()` macro ](#mcdictionary-macro-10 ) +11. [`%mchashtable()` macro ](#mchashtable-macro-11 ) +12. [`%qziparrays()` macro ](#qziparrays-macro-12 ) +13. [`%sortmacroarray()` macro ](#sortmacroarray-macro-13 ) +14. [`%ziparrays()` macro ](#ziparrays-macro-14 ) + + +15. [License note](#license) + +--- + +## `%appendarray()` macro ###### + The `%appendArray()` macro is a macrowrapper which allows to concatenate two macroarrays created by `%array()` macro. @@ -111,9 +132,7 @@ The basic syntax is the following, the `<...>` means optional parameters: 2. `second` - *Required*, a name of a macroarray created by the `%array()` macro. - - - + ### EXAMPLES AND USECASES: ###################################################### **EXAMPLE 1.** Append macroarrays LL and MM. @@ -146,10 +165,11 @@ The basic syntax is the following, the `<...>` means optional parameters: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --- - + +--- + +## `%appendcell()` macro ###### -## >>> `%appendCell()` macro: <<< ############## - The `%appendCell()` macro allows to append a macrovariable to a macroarray created by the `%array()` macro. @@ -176,10 +196,8 @@ The basic syntax is the following, the `<...>` means optional parameters: 3. `hilo` - *Required*, if `H` macrovariable is appended at the end if `L` macrovariable is appended at the beginning -); - - + ### EXAMPLES AND USECASES: #################################################### **EXAMPLE 1.** Create two macro wrappers. @@ -235,10 +253,11 @@ The basic syntax is the following, the `<...>` means optional parameters: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --- - - -## >>> `%array()` macro: <<< ####################### - + +--- + +## `%array()` macro ###### + The code of a macro was inspired by *Ted Clay's* and *David Katz's* macro `%array()`. @@ -351,8 +370,6 @@ The basic syntax is the following, the `<...>` means optional parameters: Value `1` is for apostrophes, value `2` is for double quotes. Ignored for `macarray=M`. - ---- ### EXAMPLES AND USECASES: #################################################### @@ -611,9 +628,11 @@ The basic syntax is the following, the `<...>` means optional parameters: --- - + +--- + +## `%concatarrays()` macro ###### -## >>> `%concatArrays()` macro: <<< ########### The `%concatArrays()` macro allows to concatenate two macroarrays created by the `%array()` macro. @@ -644,9 +663,7 @@ The basic syntax is the following, the `<...>` means optional parameters: * `removeSecond=Y` - *Optional*, default value `Y`, if set to `Y` then the second array is removed. - - - + ### EXAMPLES AND USECASES: #################################################### **EXAMPLE 1.** Concatenate macroarrays LL and MM. @@ -679,10 +696,11 @@ The basic syntax is the following, the `<...>` means optional parameters: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --- - + +--- + +## `%deletemacarray()` macro ###### -## >>> `%deleteMacArray()` macro: <<< ####### - The `%deleteMacArray()` macro allows to delete macroarrays created by the `%array()` macro. @@ -702,15 +720,15 @@ The basic syntax is the following, the `<...>` means optional parameters: 1. `arrs` - *Required*, a space separated list of manes of macroarray created by the `%array()` macro. - + * `macarray=N` - *Optional*, indicator should a macro associated with macroarray to be deleted? If `Y` or `YES` then the associated macro is deleted. - - + +--- -## >>> `%do_over()` macro: <<< ###################### +## `%do_over()` macro ###### The code of the macro was inspired by *Ted Clay's* and *David Katz's* macro `%do_over()`. @@ -725,17 +743,22 @@ The `%do_over()` macro executes like a pure macro code. The basic syntax is the following, the `<...>` means optional parameters: ~~~~~~~~~~~~~~~~~~~~~~~sas %do_over( - array - <,phrase=%nrstr(%&array(&_I_.))> - <,between=%str( )> + arrays + <,phrase = %nrstr(%&array(&_I_.))> + <,between = %str( )> <,which = > + <,check = 0> + <,rephrase = > + <,trigger = ?> + <,unq = 1> ) ~~~~~~~~~~~~~~~~~~~~~~~ **Arguments description**: -1. `array` - *Required*, indicates a macroarray which metadata (Lbound, Hbouns) - are to be used to loop in the `%do_over()` +1. `arrays` - *Required*, a space-separated list of macroarrays names. + The first one identifies the macroarray which metadata + (Lbound, Hbouns, and N) are used to loop in the `%do_over()`. * `phrase=` - *Optional*, Default value `%nrstr(%&array(&_I_.))`, a statement to be called in each iteration @@ -750,7 +773,7 @@ The basic syntax is the following, the `<...>` means optional parameters: If macroquoted (e.g. `%str( + )`) then the `%unquote()` function is automatically applied. -* `which=` - *Optional*, a _SPACE_ separated list of indexes which +* `which=` - *Optional*, a space-separated list of indexes which should be used to iterate over selected macroarray. Possible special characters are `H` and `L` which means *high* and *low* bound of an array, list could be set with @@ -758,15 +781,58 @@ The basic syntax is the following, the `<...>` means optional parameters: if `by` is omitted the default is `1`. If possible use `1:5` rather `1 2 3 4 5` since the firs works faster. +* `check=` - *Optional*, indicates should a check for a macro corresponding + to a macroarray be executed. If the macro does not exist wraning + is issued and the `do_over` stops. + Default value `0` means: do not execute check. +* `rephrase=` - *Optional*, this parameter allows for an alternative aproach + in providing the phrase to be looped over. The idea is to make + writing the phrase string code more convenient and easy to grasp. + The value is a string containing triggers (symbols) that are + replaced by proper macroarray calls. For example, if a macroarray + `myArr` has 7 values form `varName1` to `varName7` and you want + to use them as arguments in code renaming variables, say + `rename old_varName1=new_varName1 ... ;`, instead typing phrase: + `rename %do_over(myArr,phrase=%nrstr(old_%myArr(&_I_.)=new_%myArr(&_I_.)));` + you can type much easier rephrase: + `rename %do_over(myArr,rephrase=old_?=new_?);`, + and all `?` will be replaced, under the hood, by calls to the macroarray. + For easier debuging the `do_over` macro prints the rephrased string + before and after chnge. + When the `do_over` loops with multiple array, say `myArrA`, `myArrB`, + and `myArrC`, then those arrays should be refered by `?1?`, `?2?`, + and `?3?` respectively. + See `trigger` parameter definition to learn more. + If both `phrase` and `rephrase` are used, the seconf takes precedence. +* `trigger=` - *Optional*, a single byte character (symbol) used for marking + macroarrays in the newly created phrase. + Default value is `?` symbol. + When one macroarray is used, only the symbol should be used in + `rephrase=` string. When multiple macroarrays are used then the + symbol should surroun a number identifying array, e.g. `?2?`. + See examples below for details. + +* `unq=` - *Optional*, indicates that the `%unquote()` macro function should + be added around every macroarray call. Because of SAS internal + behavior `unq=1` is needed for certain cases when plain 4GL code + is used in `rephrase=`. For example, let macro array `myArr()` + has 3 values: `A1`, `B2`, and `C3`. When the following code + is run: `%do_over(myArr, rephrase=data ?_test; run;)` without + `unq=1`, SAS will create 4 data sets: `A1`, `B2`, `C3`, + and `_test`, instead 3 data sets: `A1_test`, `B2_test`, and `C3_test`. + Default value `1` means: add the `%unquote()`. + See example below to learn more. + + ### EXAMPLES AND USECASES: #################################################### **EXAMPLE 1.** Simple looping. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas %array(beta[*] j k l m (101 102 103 104), vnames=Y, macarray=Y) - + %put #%do_over(beta)#; %put #%do_over(beta, phrase=%nrstr("%beta(&_I_.)"), between=%str(,))#; @@ -856,7 +922,6 @@ The basic syntax is the following, the `<...>` means optional parameters: %array(alpha[11] (5:15), macarray=Y) %let x = %do_over(alpha - , phrase = %NRSTR(%alpha(&_I_.)) , between= %str( + ) ); %put &=x.; @@ -887,12 +952,113 @@ The basic syntax is the following, the `<...>` means optional parameters: %put #%do_over(test, which= L:H h:l:-1 13 14, between=%str(,))#; ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +**EXAMPLE 8.** Simpler multiple arrays looping with `rephrase=`. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas + %array(alpha[*] j k l m n o p, vnames=Y, macarray=Y) + %array( beta[&alphaN.], function = (2**_i_), macarray=Y) + %array(gamma[&alphaN.] (1:&alphaN.), macarray=Y) + + %put >>%do_over(alpha)<<; + %put >>%do_over(beta)<<; + %put >>%do_over(gamma)<<; + + data test8; + call streaminit(123); + + %do_over( alpha beta gamma + , rephrase = ?1? = ?2? + ?3? * rand('Uniform'); output; + , between = put _all_; + ) + put _all_; + run; +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +**EXAMPLE 9.** Simpler multiple arrays looping with `rephrase=`, cont. + Create multiple datasets. Array `alpha`, `beta`, and `gamma` are + from the privious example. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas + %do_over(alpha beta gamma + , rephrase = + data ?1?_2; + call streaminit(?2?); + ?1?X = ?2? + ?3? * rand('Uniform'); + output; + run; + ) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +**EXAMPLE 10.** Simpler multiple arrays looping with `rephrase=`, cont. + Create multiple datasets using a macro. Array `alpha`, `beta`, + and `gamma` are from the privious example. + The `%nrstr()` is required to mask call to the `%doit2()` macro. + Default `?` is replaced with `@`. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas + %macro doit2(ds, var=a, val1=1, val2=2); + data &ds._3; + call streaminit(&val1.); + &var. = &val1. + &val2. * rand('Uniform'); + output; + run; + %mend doit2; + + %do_over( alpha beta gamma + , rephrase = %nrstr(%doit2(@1@, var = @1@, val1 = @2@, val2 = @3@)) + , trigger = @ + ) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +**EXAMPLE 11.** Simpler multiple arrays looping with `rephrase=`, cont. + Why the `unq=` is needed. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas + %array(myArr[3] $ ("A1" "B2" "C3"), macarray=Y) + + %do_over(myArr, rephrase=data ?_testUNQ1; run;, unq=1) + + %do_over(myArr, rephrase=data ?_testUNQ0; run;, unq=0) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + + +**EXAMPLE 12.** Simpler multiple arrays looping with `rephrase=`, cont. + Renaming variables is easy now. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas + %array(V[*] a b c d e f g h, vnames=1, macarray=1) + + data test12; + array x{*} %do_over(V) (1:&VN.); + run; + + proc datasets nolist noprint lib=work; + modify test12; + rename + %do_over(V,rephrase = $=new_$,trigger=$) + ; + run; + quit; + + data _null_; + set test12; + put _ALL_; + run; +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +--- + --- - - -## >>> `%do_over2()` macro: <<< #################### - +## `%do_over2()` macro ###### + The code of the macro was inspired by *Ted Clay's* and *David Katz's* macro `%do_over()`. @@ -935,9 +1101,7 @@ The basic syntax is the following, the `<...>` means optional parameters: If macroquoted (e.g. `%str( + )`) then the `%unquote()` function is automatically applied. - - - + ### EXAMPLES AND USECASES: #################################################### **EXAMPLE 1.** Looping over two arrays. @@ -981,11 +1145,11 @@ The basic syntax is the following, the `<...>` means optional parameters: %put %sysevalf(&x.); ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --- - - + +--- + +## `%do_over3()` macro ###### -## >>> `%do_over3()` macro: <<< #################### - The code of the macro was inspired by *Ted Clay's* and *David Katz's* macro `%do_over()`. @@ -1032,9 +1196,7 @@ The basic syntax is the following, the `<...>` means optional parameters: If macroquoted (e.g. `%str( + )`) then the `%unquote()` function is automatically applied. - - - + ### EXAMPLES AND USECASES: #################################################### **EXAMPLE 1.** Looping over 3 macroarrays. @@ -1059,11 +1221,11 @@ The basic syntax is the following, the `<...>` means optional parameters: ) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --- - - + +--- + +## `%make_do_over()` macro ###### -## >>> `%make_do_over()` macro: <<< ########### - The code of the macro was inspired by *Ted Clay's* and *David Katz's* macro `%do_over()`. @@ -1086,9 +1248,7 @@ The basic syntax is the following, the `<...>` means optional parameters: 1. `size` - *Required*, indicates the number of dimensions (i.e. inner loops) of the `%DO_OVER()` macro. - - - + ### EXAMPLES AND USECASES: #################################################### **EXAMPLE 1.** Code of created "4-loop" `%DO_OVER4()` macro @@ -1181,9 +1341,342 @@ The basic syntax is the following, the `<...>` means optional parameters: ); ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --- + +--- + +## `%mcdictionary()` macro ###### + +The `%mcDictionary()` macro provided in the package +is designed to facilitate the idea of a "macro dictionary" +concept, i.e. *a list of macrovariables with common prefix +and suffixes generated as a hash digest* which allows +to use values other than integers as indexes. -## >>> `%mcHashTable()` macro: <<< ####################### +The `%mcDictionary()` macro allows to generate other macros +which behaves like a dictionary. See examples below. +The `%mcDictionary()` macro executes like a pure macro code. + +### SYNTAX: ################################################################### + +The basic syntax is the following, the `<...>` means optional parameters: +~~~~~~~~~~~~~~~~~~~~~~~sas +%mcDictionary( + H + <,METHOD> + <,DS=> + <,K=Key> + <,D=Data> +) +~~~~~~~~~~~~~~~~~~~~~~~ + +**Arguments description**: + +1. `H` - *Required*, a dictionary macro name and a declaration/definition, + e.g. `mcDictionary(HT)`. It names a macro which is generated by + the `%mcDictionary()` macro. Provided name cannot be empty + or an underscore (`_`). No longer than *13* characters. + +2. `METHOD` - *Optional*, if empty (or DECLARE or DCL) then the code of + a macro dictionary is compiled. + If `DELETE` then the macro dictionary named by `H` and all + macrovariables named like "`&H._`" are deleted. + +* `DS=` - *Optional*, if NOT empty then the `&DS.` dataset is used to + populate dictionary with keys from variable `&K.` and data + from variable `&D.` Works only during declaration. + +* `K=` - *Optional*, if the `&DS.` is NOT empty then `&K.` holds a name of + a variable which keeps or an expression which generates keys values. + Default is `Key`. + +* `D=` - *Optional*, if the `&DS.` is NOT empty then `&D.` holds a name of + a variable which keeps or an expression which generates data values. + Default is `Data`. + +--- + +### THE CREATED MACRO `%&H.()`: #################################################### + +The created macro imitates behaviour of a dictionary. + +The basic syntax is the following, the `<...>` means optional parameters: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%&H.( + METHOD + <,KEY=> + <,DATA=> +) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Arguments description**: + +1. `METHOD` - *Required*, indicate what behaviour should be executed. + Allowed values are: + - `ADD`, adds key and data portion to the macro dictionary, + *multiple data portions* are NOT available for one key. + - `FIND`, tests if given key exists in the macro dictionary + and, if yes, returns data value associated with the key. + For multiple data portions see the `data=` parameter. + - `CHECK`, returns indicator if the key exists in dictionary. + - `DEL`, removes key and data portion from the macro dictionary. + - `LIST`, prints out a dictionary to the log. + - `CLEAR` removes all data and keys values. + +* `KEY=` - *Optional*, provides key value for `ADD`, `FIND`, `CHECK` + and `DEL` methods. + Leading and trimming spaces are removed from the value. + The `MD5(...)` function is used to generate the hash. + Default value is `_`. + +* `DATA=` - *Optional*, provides data value for the `ADD` method. + Default value is blank. + + +When macro is executed and when data are added the following types of +*global* macrovariables are created: +- `&H._########_K`, +- `&H._########_V`, +- `&H._KEYSNUM`. + +The `#` represents value generated by the `MD5(...)` function for the given key. + +The first type keeps information about the key. + +The second type keeps information about the value of a given key + +The third type keeps the number of unique values of the key. + +See examples below to see use cases. + +--- + +### EXAMPLES AND USECASES: #################################################### + + +**EXAMPLE 1.** Basic use-case. + Creating macro dictionary, macro `Dict` is generated. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%mcDictionary(Dict) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Add elements to the `Dict`. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%Dict(ADD,key=x,data=17) +%Dict(ADD,key=y y,data=42) +%Dict(ADD,key=z z z,data=303) + +%put _user_; +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Add some duplicates for the key x. + See macrovariables created. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%Dict(ADD,key=x,data=18) + +%put _user_; + +%Dict(ADD,key=x,data=19) + +%put _user_; +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Check for the key `x` and non existing key `t`. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%put ##%Dict(CHECK,key=x)##; +%put ##%Dict(CHECK,key=t)##; +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Prints data values for various keys. + Key `t` does not exist in the macrodictionary. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%put #%Dict(FIND,key=x)#; +%put #%Dict(FIND,key=y y)#; +%put #%Dict(FIND,key=z z z)#; +%put #%Dict(FIND,key=t)#; +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + List dictionary content to the log. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%Dict(LIST); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Delete keys. + Key `t` does not exist in the macrodictionary. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%put #%Dict(DEL,key=z z z)#; +%put _user_; +%put #%Dict(DEL,key=t)#; +%put _user_; +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Clear and delete macro dictionary `Dict`. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%Dict(CLEAR) +%put _user_; + +%mcDictionary(Dict,DELETE) +%put _user_; +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +**EXAMPLE 2A.** Populate macro dictionary from a dataset "by hand". + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%mcDictionary(CLASS) +%let t = %sysfunc(datetime()); +data _null_; + set sashelp.class; + call execute('%CLASS(ADD,key=' !! name !! ',data=' !! age !! ')'); +run; +%put t = %sysevalf(%sysfunc(datetime()) - &t.); +%put &=Class_KEYSNUM.; +%put _user_; +%CLASS(CLEAR) + + +%mcDictionary(CARS) +%let t = %sysfunc(datetime()); +data _null_; + set sashelp.cars(obs=42); + call execute('%CARS(ADD,key=' !! catx("|",make,model,type) !! ',data=' !! put(MPG_CITY*10,dollar10.2) !! ')'); +run; +%put t = %sysevalf(%sysfunc(datetime()) - &t.); +%put &=CARS_KEYSNUM.; +%CARS(LIST); + +%put %CARS(F,key=Audi|TT 3.2 coupe 2dr (convertible)|Sports); + +%CARS(CLEAR) +%put &=CARS_KEYSNUM.; +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +**EXAMPLE 2B.** Populate macro dictionary from a dataset "automatically". + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%let t = %sysfunc(datetime()); +%mcDictionary(CLASS,DCL,DS=sashelp.class,k=name,d=_N_) +%put t = %sysevalf(%sysfunc(datetime()) - &t.); +%put &=CLASS_KEYSNUM.; +%put _user_; +%CLASS(CLEAR) + + +%let t = %sysfunc(datetime()); +%mcDictionary(CARS,DCL,DS=sashelp.cars(obs=42),k=catx("|",make,model,type),d=put(MPG_CITY*10,dollar10.2)) +%put t = %sysevalf(%sysfunc(datetime()) - &t.); +%put &=CARS_KEYSNUM.; +%CARS(LIST); + +%put %CARS(F,key=Audi|TT 3.2 coupe 2dr (convertible)|Sports); + +%CARS(CLEAR) +%put &=CARS_KEYSNUM.; +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +**EXAMPLE 3.** Data portion may require quoting and un-quoting. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%mcDictionary(CODE) +%CODE(CLEAR) +%CODE(ADD,key=data, data=%str(data test; x = 42; run;)) +%CODE(ADD,key=proc, data=%str(proc print; run;)) +%CODE(ADD,key=macro,data=%nrstr(%put *1*2*3*4*;)) + +%CODE(FIND,key=data) +%CODE(FIND,key=proc) +%unquote(%CODE(FIND,key=macro)) + +%CODE(LIST); + +%mcDictionary(CODE,DELETE) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +**EXAMPLE 4.** Longer lists. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%let size = 1000; + +%mcDictionary(AAA) + +%let t = %sysfunc(datetime()); +data _null_; + do i = 1 to &size.; + call execute(cats('%AAA(ADD,key=A', i, ',data=', i, ')')); + end; +run; +%put t = %sysevalf(%sysfunc(datetime()) - &t.); +%put %AAA(F,key=A555) %AAA(CHECK,key=A555); +%put &=AAA_KEYSNUM; +%AAA(CLEAR) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +**EXAMPLE 5.** Forbidden names. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas +%mcDictionary() +%mcDictionary(_) + +%mcDictionary(ABCDEFGHIJKLMN) %* bad; +%mcDictionary(ABCDEFGHIJKLM) %* good; +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +**EXAMPLE 6.** More fun with datasets. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas + +data work.metadata; + input key :$16. data :$128.; +cards; +ID ABC-123-XYZ +path /path/to/study/data +cutoffDT 2023-01-01 +startDT 2020-01-01 +endDT 2024-12-31 +MedDRA v26.0 +; +run; +proc print; +run; + +%mcDictionary(Study,dcl,DS=work.metadata) + +%put _user_; + +%put *%Study(F,key=ID)**%Study(C,key=ID)*; + +title1 "Study %Study(F,key=ID) is located at %Study(F,key=path)"; +title2 "it starts %Study(F,key=startDT) and ends %Study(F,key=endDT)"; +footnote "MedDRA version: %Study(F,key=MedDRA)"; + +proc print data=sashelp.class(obs=7); +run; + +title; +footnote; + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + + +--- + +--- + +## `%mchashtable()` macro ###### + The `%mcHashTable()` macro provided in the package is designed to facilitate the idea of a "macro hash table" concept, i.e. *a list of macrovariables with common prefix @@ -1296,7 +1789,7 @@ the `i` indicates key number. See examples below to see use cases. --- - + ### EXAMPLES AND USECASES: #################################################### @@ -1524,8 +2017,8 @@ run; %mcHashTable() %mcHashTable(_) -%mcHashTable(ABCDEFGHIJKLMNOPQ) %* bad; -%mcHashTable(ABCDEFGHIJKLMNOP) %* good; +%mcHashTable(ABCDEFGHIJK) %* bad; +%mcHashTable(ABCDEFGHIJ) %* good; ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **EXAMPLE 7.** Hashing algorithms. @@ -1536,339 +2029,14 @@ run; ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --- - -## >>> `%mcDictionary()` macro: <<< ####################### - -The `%mcDictionary()` macro provided in the package -is designed to facilitate the idea of a "macro dictionary" -concept, i.e. *a list of macrovariables with common prefix -and suffixes generated as a hash digest* which allows -to use values other than integers as indexes. - -The `%mcDictionary()` macro allows to generate other macros -which behaves like a dictionary. See examples below. - -The `%mcDictionary()` macro executes like a pure macro code. - -### SYNTAX: ################################################################### - -The basic syntax is the following, the `<...>` means optional parameters: -~~~~~~~~~~~~~~~~~~~~~~~sas -%mcDictionary( - H - <,METHOD> - <,DS=> - <,K=Key> - <,D=Data> -) -~~~~~~~~~~~~~~~~~~~~~~~ - -**Arguments description**: - -1. `H` - *Required*, a dictionary macro name and a declaration/definition, - e.g. `mcDictionary(HT)`. It names a macro which is generated by - the `%mcDictionary()` macro. Provided name cannot be empty - or an underscore (`_`). No longer than *13* characters. - -2. `METHOD` - *Optional*, if empty (or DECLARE or DCL) then the code of - a macro dictionary is compiled. - If `DELETE` then the macro dictionary named by `H` and all - macrovariables named like "`&H._`" are deleted. - -* `DS=` - *Optional*, if NOT empty then the `&DS.` dataset is used to - populate dictionary with keys from variable `&K.` and data - from variable `&D.` Works only during declaration. - -* `K=` - *Optional*, if the `&DS.` is NOT empty then `&K.` holds a name of - a variable which keeps or an expression which generates keys values. - Default is `Key`. - -* `D=` - *Optional*, if the `&DS.` is NOT empty then `&D.` holds a name of - a variable which keeps or an expression which generates data values. - Default is `Data`. - ---- - -### THE CREATED MACRO `%&H.()`: #################################################### - -The created macro imitates behaviour of a dictionary. - -The basic syntax is the following, the `<...>` means optional parameters: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%&H.( - METHOD - <,KEY=> - <,DATA=> -) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -**Arguments description**: - -1. `METHOD` - *Required*, indicate what behaviour should be executed. - Allowed values are: - - `ADD`, adds key and data portion to the macro dictionary, - *multiple data portions* are NOT available for one key. - - `FIND`, tests if given key exists in the macro dictionary - and, if yes, returns data value associated with the key. - For multiple data portions see the `data=` parameter. - - `CHECK`, returns indicator if the key exists in dictionary. - - `DEL`, removes key and data portion from the macro dictionary. - - `LIST`, prints out a dictionary to the log. - - `CLEAR` removes all data and keys values. - -* `KEY=` - *Optional*, provides key value for `ADD`, `FIND`, `CHECK` - and `DEL` methods. - Leading and trimming spaces are removed from the value. - The `MD5(...)` function is used to generate the hash. - Default value is `_`. - -* `DATA=` - *Optional*, provides data value for the `ADD` method. - Default value is blank. - - -When macro is executed and when data are added the following types of -*global* macrovariables are created: -- `&H._########_K`, -- `&H._########_V`, -- `&H._KEYSNUM`. - -The `#` represents value generated by the `MD5(...)` function for the given key. - -The first type keeps information about the key. - -The second type keeps information about the value of a given key - -The third type keeps the number of unique values of the key. - -See examples below to see use cases. - ---- - -### EXAMPLES AND USECASES: #################################################### - - -**EXAMPLE 1.** Basic use-case. - Creating macro dictionary, macro `Dict` is generated. - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%mcDictionary(Dict) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Add elements to the `Dict`. - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%Dict(ADD,key=x,data=17) -%Dict(ADD,key=y y,data=42) -%Dict(ADD,key=z z z,data=303) - -%put _user_; -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Add some duplicates for the key x. - See macrovariables created. - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%Dict(ADD,key=x,data=18) - -%put _user_; - -%Dict(ADD,key=x,data=19) - -%put _user_; -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Check for the key `x` and non existing key `t`. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%put ##%Dict(CHECK,key=x)##; -%put ##%Dict(CHECK,key=t)##; -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Prints data values for various keys. - Key `t` does not exist in the macrodictionary. - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%put #%Dict(FIND,key=x)#; -%put #%Dict(FIND,key=y y)#; -%put #%Dict(FIND,key=z z z)#; -%put #%Dict(FIND,key=t)#; -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - List dictionary content to the log. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%Dict(LIST); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Delete keys. - Key `t` does not exist in the macrodictionary. - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%put #%Dict(DEL,key=z z z)#; -%put _user_; -%put #%Dict(DEL,key=t)#; -%put _user_; -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Clear and delete macro dictionary `Dict`. - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%Dict(CLEAR) -%put _user_; - -%mcDictionary(Dict,DELETE) -%put _user_; -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -**EXAMPLE 2A.** Populate macro dictionary from a dataset "by hand". - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%mcDictionary(CLASS) -%let t = %sysfunc(datetime()); -data _null_; - set sashelp.class; - call execute('%CLASS(ADD,key=' !! name !! ',data=' !! age !! ')'); -run; -%put t = %sysevalf(%sysfunc(datetime()) - &t.); -%put &=Class_KEYSNUM.; -%put _user_; -%CLASS(CLEAR) - - -%mcDictionary(CARS) -%let t = %sysfunc(datetime()); -data _null_; - set sashelp.cars(obs=42); - call execute('%CARS(ADD,key=' !! catx("|",make,model,type) !! ',data=' !! put(MPG_CITY*10,dollar10.2) !! ')'); -run; -%put t = %sysevalf(%sysfunc(datetime()) - &t.); -%put &=CARS_KEYSNUM.; -%CARS(LIST); - -%put %CARS(F,key=Audi|TT 3.2 coupe 2dr (convertible)|Sports); - -%CARS(CLEAR) -%put &=CARS_KEYSNUM.; -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -**EXAMPLE 2B.** Populate macro dictionary from a dataset "automatically". - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%let t = %sysfunc(datetime()); -%mcDictionary(CLASS,DCL,DS=sashelp.class,k=name,d=_N_) -%put t = %sysevalf(%sysfunc(datetime()) - &t.); -%put &=CLASS_KEYSNUM.; -%put _user_; -%CLASS(CLEAR) - - -%let t = %sysfunc(datetime()); -%mcDictionary(CARS,DCL,DS=sashelp.cars(obs=42),k=catx("|",make,model,type),d=put(MPG_CITY*10,dollar10.2)) -%put t = %sysevalf(%sysfunc(datetime()) - &t.); -%put &=CARS_KEYSNUM.; -%CARS(LIST); - -%put %CARS(F,key=Audi|TT 3.2 coupe 2dr (convertible)|Sports); - -%CARS(CLEAR) -%put &=CARS_KEYSNUM.; -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -**EXAMPLE 3.** Data portion may require quoting and un-quoting. - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%mcDictionary(CODE) -%CODE(CLEAR) -%CODE(ADD,key=data, data=%str(data test; x = 42; run;)) -%CODE(ADD,key=proc, data=%str(proc print; run;)) -%CODE(ADD,key=macro,data=%nrstr(%put *1*2*3*4*;)) - -%CODE(FIND,key=data) -%CODE(FIND,key=proc) -%unquote(%CODE(FIND,key=macro)) - -%CODE(LIST); - -%mcDictionary(CODE,DELETE) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -**EXAMPLE 4.** Longer lists. - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%let size = 1000; - -%mcDictionary(AAA) - -%let t = %sysfunc(datetime()); -data _null_; - do i = 1 to &size.; - call execute(cats('%AAA(ADD,key=A', i, ',data=', i, ')')); - end; -run; -%put t = %sysevalf(%sysfunc(datetime()) - &t.); -%put %AAA(F,key=A555) %AAA(CHECK,key=A555); -%put &=AAA_KEYSNUM; -%AAA(CLEAR) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -**EXAMPLE 5.** Forbidden names. - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas -%mcDictionary() -%mcDictionary(_) - -%mcDictionary(ABCDEFGHIJKLMNOPQ) %* bad; -%mcDictionary(ABCDEFGHIJKLMNOP) %* good; -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -**EXAMPLE 6.** More fun with datasets. - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas - -data work.metadata; - input key :$16. data :$128.; -cards; -ID ABC-123-XYZ -path /path/to/study/data -cutoffDT 2023-01-01 -startDT 2020-01-01 -endDT 2024-12-31 -MedDRA v26.0 -; -run; -proc print; -run; - -%mcDictionary(Study,dcl,DS=work.metadata) - -%put _user_; - -%put *%Study(F,key=ID)**%Study(C,key=ID)*; - -title1 "Study %Study(F,key=ID) is located at %Study(F,key=path)"; -title2 "it starts %Study(F,key=startDT) and ends %Study(F,key=endDT)"; -footnote "MedDRA version: %Study(F,key=MedDRA)"; - -proc print data=sashelp.class(obs=7); -run; - -title; -footnote; - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - --- - -## >>> `%QzipArrays()` macro: <<< ####################### - + +## `%qziparrays()` macro ###### + The zipArrays() and QzipArrays() macros allow to use a function on elements of pair of -macroarrays. +macro arrays. For two macroarrays the corresponding elements are taken and the macro applies a function, provided by user, @@ -1969,17 +2137,110 @@ The basic syntax is the following, the `<...>` means optional parameters: cut the process with the end of the shorter array. See examples for the details. + ### EXAMPLES AND USECASES: #################################################### See examples in `%zipArrays()` help for the details. --- + +--- + +## `%sortmacroarray()` macro ###### -## >>> `%zipArrays()` macro: <<< ####################### +The sortMacroArray() macro +allow to sort elements of a macro array. +The **limitation** is that sorted values are limited to 32767 bytes of length. + +See examples below for the details. + +### SYNTAX: ################################################################### + +The basic syntax is the following, the `<...>` means optional parameters: +~~~~~~~~~~~~~~~~~~~~~~~sas +%sortMacroArray( + array + <,valLength=> + <,outSet=> + <,sortseq=> +) +~~~~~~~~~~~~~~~~~~~~~~~ + +**Arguments description**: + +1. `array` - *Required*, name of an array generated by the `%array()` macro. + +* `valLength = 32767` - *Optional*, default value is `32767`, + maximum length of a variable storing macrovariable data. + (the reason of 32767 limitation) + +* `outSet = _NULL_` - *Optional*, default value is `_NULL_`, + an optional output dataset name. + +* `sortseq =` - *Optional*, default value is `LINGUISTIC(NUMERIC_COLLATION = ON)`, + sorting options for use in an internal `Proc SORT`. + + +### EXAMPLES AND USECASES: #################################################### + + +**EXAMPLE 1.** Basic use-case. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas + +options mprint; +ods html; +ods listing close; + + +%array(hij [4:9] $ 512 ("C33" "B22" "A11" "A01" "A02" "X42"), macarray=Y) + +%put NOTE: %do_over(hij); + +%sortMacroArray(hij, valLength=3, outSet = A_NULL_(compress=char)) + +%put NOTE: %do_over(hij); + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +**EXAMPLE 2.** Basic use-case. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas + +options mprint; +ods html; +ods listing close; + + +%array(ds = sashelp.class, vars = name|NNN height|h, macarray=Y) +%array(ds = sashelp.cars, vars = model|, macarray=Y) + +%put NOTE: %do_over(NNN); +%put NOTE: %do_over(H); +%put NOTE: %do_over(model); + +%sortMacroArray(NNN, valLength=30, outSet = A_NULL_(compress=char)) +%sortMacroArray(H, valLength=32) +%sortMacroArray(model, valLength=120) + +%put NOTE: %do_over(NNN); +%put NOTE: %do_over(H); +%put NOTE: %do_over(model); + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +--- + + +--- + +## `%ziparrays()` macro ###### + The zipArrays() and QzipArrays() macros allow to use a function on elements of pair of -macroarrays. +macro arrays. For two macroarrays the corresponding elements are taken and the macro applies a function, provided by user, @@ -2080,6 +2341,7 @@ The basic syntax is the following, the `<...>` means optional parameters: cut the process with the end of the shorter array. See examples for the details. + ### EXAMPLES AND USECASES: #################################################### **EXAMPLE 1.** Simple concatenation of elements: @@ -2174,96 +2436,15 @@ The basic syntax is the following, the `<...>` means optional parameters: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --- - -## >>> `%sortMacroArray()` macro: <<< ####################### - -The sortMacroArray() macro -allow to sort elements of a macroarray. - -The **limitation** is that sorted values are limited to 32767 bytes of length. - -See examples below for the details. - -### SYNTAX: ################################################################### - -The basic syntax is the following, the `<...>` means optional parameters: -~~~~~~~~~~~~~~~~~~~~~~~sas -%sortMacroArray( - array - <,valLength=> - <,outSet=> - <,sortseq=> -) -~~~~~~~~~~~~~~~~~~~~~~~ - -**Arguments description**: - -1. `array` - *Required*, name of an array generated by the `%array()` macro. - -* `valLength = 32767` - *Optional*, default value is `32767`, - maximum length of a variable storing macrovariable data. - (the reason of 32767 limitation) - -* `outSet = _NULL_` - *Optional*, default value is `_NULL_`, - an optional output dataset name. - -* `sortseq =` - *Optional*, default value is `LINGUISTIC(NUMERIC_COLLATION = ON)`, - sorting options for use in an internal `Proc SORT`. - -### EXAMPLES AND USECASES: #################################################### - - -**EXAMPLE 1.** Basic use-case. - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas - -options mprint; -ods html; -ods listing close; - - -%array(hij [4:9] $ 512 ("C33" "B22" "A11" "A01" "A02" "X42"), macarray=Y) - -%put NOTE: %do_over(hij); - -%sortMacroArray(hij, valLength=3, outSet = A_NULL_(compress=char)) - -%put NOTE: %do_over(hij); - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -**EXAMPLE 2.** Basic use-case. - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas - -options mprint; -ods html; -ods listing close; - - -%array(ds = sashelp.class, vars = name|NNN height|h, macarray=Y) -%array(ds = sashelp.cars, vars = model|, macarray=Y) - -%put NOTE: %do_over(NNN); -%put NOTE: %do_over(H); -%put NOTE: %do_over(model); - -%sortMacroArray(NNN, valLength=30, outSet = A_NULL_(compress=char)) -%sortMacroArray(H, valLength=32) -%sortMacroArray(model, valLength=120) - -%put NOTE: %do_over(NNN); -%put NOTE: %do_over(H); -%put NOTE: %do_over(model); - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - + --- - -## License #################################################################### - -Copyright (c) Bartosz Jablonski, since January 2019 + + +--- + +# License ###### + +Copyright (c) Bartosz Jablonski, 2019 - 2026 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -2282,5 +2463,6 @@ 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. - + --- + diff --git a/packages/macroarray.zip b/packages/macroarray.zip index c42bf1c..88d9e47 100644 Binary files a/packages/macroarray.zip and b/packages/macroarray.zip differ