sasjs/core
1
0
Fork 0
mirror of https://github.com/sasjs/core.git synced 2026-01-09 18:30:06 +00:00
Code Issues Projects Releases Wiki Activity

chore: updating documentation in preparation for upcoming sasjs snippets feature

Browse Source
This commit is contained in:
Allan
2023-08-18 08:20:13 +01:00
parent d39b1be7a8
commit d42fd4ebac
124 changed files with 970 additions and 814 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
base/mf_abort.sas
View File

@@ -3,6 +3,11 @@
@brief Abort, ungracefully
@details Will abort with a straightforward %abort if the condition is true.
@param [in] mac= (mf_abort.sas) Name of calling macro (is printed to the log)
@param [in] msg= ( ) Additional string to print to the log
@param [in] iftrue= (%str(1=1)) Conditional logic under which to perform the
abort
<h4> Related Macros </h4>
@li mp_abort.sas

2
base/mf_deletefile.sas
View File

@@ -10,7 +10,7 @@
%mf_deletefile(&sasjswork/myfile.txt)
@param filepath Full path to the target file
@param [in] file Full path to the target file
@returns The return code from the fdelete() invocation

2
base/mf_existds.sas
View File

@@ -10,7 +10,7 @@
expected results (depending on whether you 'expect' the result to be
case insensitive in this context!)
@param libds library.dataset
@param [in] libds library.dataset
@return output returns 1 or 0
<h4> Related Macros </h4>

2
base/mf_existfileref.sas
View File

@@ -4,7 +4,7 @@
@details You can probably do without this macro as it is just a one liner.
Mainly it is here as a convenient way to remember the syntax!
@param fref the fileref to detect
@param [in] fref the fileref to detect
@return output Returns 1 if found and 0 if not found. Note - it is possible
that the fileref is found, but the file does not (yet) exist. If you need

2
base/mf_existfunction.sas
View File

@@ -16,7 +16,7 @@
https://github.com/yabwon/SAS_PACKAGES/blob/main/packages/baseplus.md#functionexists-macro
).
@param [in] name (positional) - function name
@param [in] name function name
@author Allan Bowe
**/

4
base/mf_existvarlist.sas
View File

@@ -6,8 +6,8 @@
%put %mf_existVarList(sashelp.class, age sex name dummyvar);
@param libds 2 part dataset or view reference
@param varlist space separated variable names
@param [in] libds 2 part dataset or view reference
@param [in] varlist space separated variable names
@version 9.2
@author Allan Bowe

1
base/mf_getapploc.sas
View File

@@ -31,6 +31,7 @@
%put %mf_getapploc(/some/location/jobs/extract/somejob/);
%put %mf_getapploc(/some/location/tests/jobs/somejob/);
@param [in] pgm The _program value from which to extract the appLoc
@author Allan Bowe
**/

4
base/mf_getattrc.sas
View File

@@ -6,8 +6,8 @@
%put Dataset label = %mf_getattrc(sashelp.class,LABEL);
%put Member Type = %mf_getattrc(sashelp.class,MTYPE);
@param libds library.dataset
@param attr full list in [documentation](
@param [in] libds library.dataset
@param [in] attr full list in [documentation](
https://support.sas.com/documentation/cdl/en/lrdict/64316/HTML/default/viewer.htm#a000147794.htm)
@return output returns result of the attrc value supplied, or -1 and log
message if err.

4
base/mf_getattrn.sas
View File

@@ -6,8 +6,8 @@
%put Number of observations=%mf_getattrn(sashelp.class,NLOBS);
%put Number of variables = %mf_getattrn(sashelp.class,NVARS);
@param libds library.dataset
@param attr Common values are NLOBS and NVARS, full list in [documentation](
@param [in] libds library.dataset
@param [in] attr Common values are NLOBS and NVARS, full list in [documentation](
http://support.sas.com/documentation/cdl/en/lrdict/64316/HTML/default/viewer.htm#a000212040.htm)
@return output returns result of the attrn value supplied, or -1 and log
message if err.

5
base/mf_getkeyvalue.sas
View File

@@ -7,8 +7,9 @@
%put %mf_getkeyvalue(someindex)
@param key Provide a key on which to perform the lookup
@param libds= define the target table which holds the parameters
@param [in] key Provide a key on which to perform the lookup
@param [in] libds= (work.mp_setkeyvalue) The library.dataset which holds the
parameters
@version 9.2
@author Allan Bowe

2
base/mf_getplatform.sas
View File

@@ -12,7 +12,7 @@
@li SASJS
@li BASESAS
@param switch the param for which to return a platform specific variable
@param [in] switch the param for which to return a platform specific variable
<h4> SAS Macros </h4>
@li mf_mval.sas

2
base/mf_getschema.sas
View File

@@ -8,7 +8,7 @@
returns:
> dbo
@param libref Library reference (also accepts a 2 level libds ref).
@param [in] libref Library reference (also accepts a 2 level libds ref).
@return output returns the library schema for the FIRST library encountered

2
base/mf_getuniquelibref.sas
View File

@@ -19,7 +19,7 @@
@param [in] prefix= (mclib) first part of the returned libref. As librefs can
be as long as 8 characters, a maximum length of 7 characters is premitted
for this prefix.
@param [in] maxtries= Deprecated parameter. Remains here to ensure a
@param [in] maxtries= (1000) Deprecated parameter. Remains here to ensure a
non-breaking change. Will be removed in v5.
@version 9.2

2
base/mf_getuniquename.sas
View File

@@ -10,7 +10,7 @@
> MCc59c750610321d4c8bf75faadbcd22
@param prefix= set a prefix for the new name
@param prefix= (MC) Sets a prefix for the new name
@version 9.3
@author Allan Bowe

2
base/mf_getuser.sas
View File

@@ -13,8 +13,6 @@
%let user= %mf_getUser();
%put &user;
@param type - do not use, may be deprecated in a future release
@return SYSUSERID (if workspace server)
@return _METAPERSON (if stored process server)
@return SYS_COMPUTE_SESSION_OWNER (if Viya compute session)

6
base/mf_getvalue.sas
View File

@@ -13,9 +13,9 @@
<h4> Related Macros </h4>
@li mp_setkeyvalue.sas
@param libds dataset to query
@param variable the variable which contains the value to return.
@param filter contents of where clause
@param [in] libds dataset to query
@param [in] variable the variable which contains the value to return.
@param [in] filter= (1) contents of where clause
@version 9.2
@author Allan Bowe

3
base/mf_getvarformat.sas
View File

@@ -25,7 +25,8 @@
@param [in] libds Two part dataset (or view) reference.
@param [in] var Variable name for which a format should be returned
@param [in] force=(0) Set to 1 to supply a default if the variable has no format
@param [in] force= (0) Set to 1 to supply a default if the variable has no
format
@returns outputs format
@author Allan Bowe

4
base/mf_getvarlen.sas
View File

@@ -18,8 +18,8 @@
8
NOTE: Variable renegade does not exist in test
@param libds Two part dataset (or view) reference.
@param var Variable name for which a length should be returned
@param [in] libds Two part dataset (or view) reference.
@param [in] var Variable name for which a length should be returned
@returns outputs length
@author Allan Bowe

4
base/mf_getvarnum.sas
View File

@@ -21,8 +21,8 @@ returns:
> NOTE: Variable renegade does not exist in test
@param libds Two part dataset (or view) reference.
@param var Variable name for which a position should be returned
@param [in] libds Two part dataset (or view) reference.
@param [in] var Variable name for which a position should be returned
@author Allan Bowe
@version 9.2

4
base/mf_getvartype.sas
View File

@@ -13,8 +13,8 @@ Usage:
@param libds Two part dataset (or view) reference.
@param var the variable name to be checked
@param [in] libds Two part dataset (or view) reference.
@param [in] var the variable name to be checked
@return output returns C or N depending on variable type. If variable
does not exist then a blank is returned and a note is written to the log.

2
base/mf_getxengine.sas
View File

@@ -10,7 +10,7 @@
returns:
> TEMP
@param fref The fileref to check
@param [in] fref The fileref to check
@returns The XENGINE value in sashelp.vextfl or 0 if not found.

4
base/mf_increment.sas
View File

@@ -11,8 +11,8 @@
%put Now we have run %mf_increment(cnt) lines;
%put There are %mf_increment(cnt) lines in total;
@param [in] MACRO_NAME the name of the macro variable to increment
@param [in] ITER= The amount to add or subtract to the macro
@param [in] macro_name The name of the macro variable to increment
@param [in] incr= (1) The amount to add or subtract to the macro
<h4> Related Files </h4>
@li mf_increment.test.sas

2
base/mf_isblank.sas
View File

@@ -12,7 +12,7 @@
inspiration:
https://support.sas.com/resources/papers/proceedings09/022-2009.pdf
@param param VALUE to be checked
@param [in] Param VALUE to be checked
@return output returns 1 (if blank) else 0

2
base/mf_isdir.sas
View File

@@ -9,7 +9,7 @@
With thanks and full credit to Andrea Defronzo -
https://www.linkedin.com/in/andrea-defronzo-b1a47460/
@param path full path of the file/directory to be checked
@param [in] path Full path of the file/directory to be checked
@return output returns 1 if path is a directory, 0 if it is not

7
base/mf_loc.sas
View File

@@ -6,6 +6,10 @@
%put %mf_loc(POF); %*location of PlatformObjectFramework tools;
@param [in] loc The item to locate, eg:
@li PLAATFORMOBJECTFRAMEWORK (or POF)
@li VIYACONFG
@version 9.2
@author Allan Bowe
**/
@@ -15,7 +19,8 @@
%local root;
%if &loc=POF or &loc=PLATFORMOBJECTFRAMEWORK %then %do;
%let root=%substr(%sysget(SASROOT),1,%index(%sysget(SASROOT),SASFoundation)-2);
%let root=%sysget(SASROOT);
%let root=%substr(&root,1,%index(&root,SASFoundation)-2);
%let root=&root/SASPlatformObjectFramework/&sysver;
%put Batch tools located at: &root;
&root

2
base/mf_mkdir.sas
View File

@@ -7,7 +7,7 @@ Usage:
%mf_mkdir(/some/path/name)
@param dir relative or absolute pathname. Unquoted.
@param [in] dir Relative or absolute pathname. Unquoted.
@version 9.2
**/

2
base/mf_mval.sas
View File

@@ -8,6 +8,8 @@
%if %mf_mval(maynotexist)=itdid %then %do;
@param [in] var The macro variable NAME to return the (possible) value for
@version 9.2
@author Allan Bowe
**/

2
base/mf_nobs.sas
View File

@@ -9,7 +9,7 @@
<h4> SAS Macros </h4>
@li mf_getattrn.sas
@param libds library.dataset
@param [in] libds library.dataset
@return output returns result of the attrn value supplied, or log message
if err.

4
base/mf_trimstr.sas
View File

@@ -11,8 +11,8 @@
<h4> SAS Macros </h4>
@param basestr The string to be modified
@param trimstr The string to be removed from the end of `basestr`, if it
@param [in] basestr The string to be modified
@param [in] trimstr The string to be removed from the end of `basestr`, if it
exists
@return output returns result with the value of `trimstr` removed from the end

4
base/mf_wordsinstr1andstr2.sas
View File

@@ -13,8 +13,8 @@
returns:
> blah blaaah brah
@param str1= string containing words to extract
@param str2= used to compare with the extract string
@param [in] str1= () string containing words to extract
@param [in] str2= () used to compare with the extract string
@warning CASE SENSITIVE!

4
base/mf_wordsinstr1butnotstr2.sas
View File

@@ -16,8 +16,8 @@
returns:
> sss bram boo
@param [in] str1= string containing words to extract
@param [in] str2= used to compare with the extract string
@param [in] str1= () String containing words to extract
@param [in] str2= () Used to compare with the extract string
@version 9.2
@author Allan Bowe

4
base/mf_writefile.sas
View File

@@ -21,8 +21,8 @@
@param [in] mode= (O) Available options are A or O as follows:
@li A APPEND mode, writes new records after the current end of the file.
@li O OUTPUT mode, writes new records from the beginning of the file.
@param [in] l1= First line
@param [in] l2= Second line (etc through to l10)
@param [in] l1= () First line
@param [in] l2= () Second line (etc through to l10)
<h4> Related Macros </h4>
@li mf_writefile.test.sas

21
base/mp_abort.sas
View File

@@ -27,14 +27,15 @@
currently investigating approaches to deal with this.
@param mac= (mp_abort.sas) To contain the name of the calling macro. Do not
use &sysmacroname as this will always resolve to MP_ABORT.
@param msg= message to be returned
@param iftrue= (1=1) Supply a condition for which the macro should be executed
@param errds= (work.mp_abort_errds) There is no clean way to end a process
within a %include called within a macro. Furthermore, there is no way to
test if a macro is called within a %include. To handle this particular
scenario, the %include should be switched for the mp_include.sas macro.
@param [in] mac= (mp_abort.sas) To contain the name of the calling macro. Do
not use &sysmacroname as this will always resolve to MP_ABORT.
@param [out] msg= message to be returned
@param [in] iftrue= (1=1) Condition under which the macro should be executed
@param [in] errds= (work.mp_abort_errds) There is no clean way to end a
process within a %include called within a macro. Furthermore, there is no
way to test if a macro is called within a %include. To handle this
particular scenario, the %include should be switched for the mp_include.sas
macro.
This provides an indicator that we are running a macro within a \%include
(`_SYSINCLUDEFILEDEVICE`) and allows us to provide a dataset with the abort
values (msg, mac).
@@ -45,8 +46,8 @@
@li msg (the message)
@li mac (the mac param)
@param mode= (REGULAR) If mode=INCLUDE then the &errds dataset is checked for
an abort status.
@param [in] mode= (REGULAR) If mode=INCLUDE then the &errds dataset is checked
for an abort status.
Valid values:
@li REGULAR (default)
@li INCLUDE

4
base/mp_aligndecimal.sas
View File

@@ -62,8 +62,8 @@
7998580.8415
@param var The (data step, character) variable to modify
@param width= (8) The number of characters BEFORE the decimal point
@param [in] var The (data step, character) variable to modify
@param [in] width= (8) The number of characters BEFORE the decimal point
<h4> SAS Macros </h4>
@li mf_getuniquename.sas

4
base/mp_appendfile.sas
View File

@@ -17,8 +17,8 @@
%mp_appendfile(baseref=tmp1, appendrefs=tmp2 tmp3)
@param [in] baseref= Fileref of the base file (should exist)
@param [in] appendrefs= One or more filerefs to be appended to the base
@param [in] baseref= (0) Fileref of the base file (should exist)
@param [in] appendrefs= (0) One or more filerefs to be appended to the base
fileref. Space separated.
@version 9.2

4
base/mp_assertcols.sas
View File

@@ -31,8 +31,8 @@
@param [in] inds The input library.dataset to test for values
@param [in] cols= The list of columns to check for
@param [in] desc= (Testing observations) The user provided test description
@param [in] cols= (0) The list of columns to check for
@param [in] desc= (0) The user provided test description
@param [in] test= (ALL) The test to apply. Valid values are:
@li ALL - Test is a PASS if ALL columns exist in &inds
@li ANY - Test is a PASS if ANY of the columns exist in &inds

2
base/mp_assertcolvals.sas
View File

@@ -36,7 +36,7 @@
@param [in] indscol The input library.dataset.column to test for values
@param [in] checkvals= A library.dataset.column value containing a UNIQUE
@param [in] checkvals= (0) A library.dataset.column value containing a UNIQUE
list of values to be compared against the source (indscol).
@param [in] desc= (Testing observations) The user provided test description
@param [in] test= (ALLVALS) The test to apply. Valid values are:

4
base/mp_base64copy.sas
View File

@@ -28,8 +28,8 @@
put _infile_;
run;
@param [in] inref= Fileref of the input file (should exist)
@param [out] outref= Output fileref. If it does not exist, it is created.
@param [in] inref= (0) Fileref of the input file (should exist)
@param [out] outref= (0) Output fileref. If it does not exist, it is created.
@param [in] action= (ENCODE) The action to take. Valid values:
@li ENCODE - Convert the file to base64 format
@li DECODE - Decode the file from base64 format

10
base/mp_binarycopy.sas
View File

@@ -22,13 +22,13 @@
%mp_binarycopy(inref=tmp1, outref=tmp2, mode=APPEND)
@param [in] inloc quoted "path/and/filename.ext" of the file to be copied
@param [out] outloc quoted "path/and/filename.ext" of the file to be created
@param [in] inref (____in) If provided, this fileref will take precedence over
@param [in] inloc= () quoted "path/and/filename.ext" of the file to be copied
@param [out] outloc= () quoted "path/and/filename.ext" of the file to create
@param [in] inref= (____in) If provided, this fileref takes precedence over
the `inloc` parameter
@param [out] outref (____in) If provided, this fileref will take precedence
@param [out] outref= (____in) If provided, this fileref takes precedence
over the `outloc` parameter. It must already exist!
@param [in] mode (CREATE) Valid values:
@param [in] mode= (CREATE) Valid values:
@li CREATE - Create the file (even if it already exists)
@li APPEND - Append to the file (don't overwrite)
@param iftrue= (1=1) Supply a condition for which the macro should be executed

2
base/mp_chop.sas
View File

@@ -44,7 +44,7 @@
For more examples, see mp_chop.test.sas
@param [in] infile The QUOTED path to the file on which to perform the chop
@param [in] matchvar= Macro variable NAME containing the string to split by
@param [in] matchvar= () Macro variable NAME containing the string to split by
@param [in] matchpoint= (START) Valid values:
@li START - chop at the beginning of the string in `matchvar`.
@li END - chop at the end of the string in `matchvar`.

2
base/mp_copyfolder.sas
View File

@@ -18,7 +18,7 @@
@param [in] source Unquoted path to the folder to copy from.
@param [out] target Unquoted path to the folder to copy to.
@param [in] copymax=(MAX) Set to a positive integer to indicate the level of
@param [in] copymax= (MAX) Set to a positive integer to indicate the level of
subdirectory copy recursion - eg 3, to go `./3/levels/deep`. For unlimited
recursion, set to MAX.

2
base/mp_createwebservice.sas
View File

@@ -1,6 +1,6 @@
/**
@file mp_createwebservice.sas
@brief Create a web service in SAS 9, Viya or SASjs Server
@brief Create a web service in SAS 9, Viya or SASjs Server (legacy)
@details This is actually a wrapper for mx_createwebservice.sas, remaining
for legacy purposes. For new apps, use mx_createwebservice.sas.

8
base/mp_csv2ds.sas
View File

@@ -19,11 +19,11 @@
%mp_csv2ds(inref=mycsv,outds=myds,baseds=sashelp.class)
@param inref= fileref to the CSV
@param outds= output ds (lib.ds format)
@param view= Set to YES or NO to determine whether the output should be
@param inref= (0) Fileref to the CSV
@param outds= (0) Output ds (lib.ds format)
@param view= (NO) Set to YES or NO to determine whether the output should be
a view or not. Default is NO (not a view).
@param baseds= Template dataset on which to create the input statement.
@param baseds= (0) Template dataset on which to create the input statement.
Is used to determine types, lengths, and any informats.
@version 9.2

7
base/mp_deleteconstraints.sas
View File

@@ -17,9 +17,10 @@
%mp_getconstraints(lib=work,ds=example,outds=work.constraints)
%mp_deleteconstraints(inds=work.constraints,outds=dropped,execute=YES)
@param inds= The input table containing the constraint info
@param outds= a table containing the drop statements (drop_statement column)
@param execute= `YES|NO` - default is NO. To actually drop, use YES.
@param inds= (mp_getconstraints) The input table containing constraint info
@param outds= (mp_deleteconstraints) Table containing the drop statements
(drop_statement column)
@param execute= (NO) `YES|NO` - default is NO. To actually drop, use YES.
@version 9.2

2
base/mp_deletefolder.sas
View File

@@ -15,7 +15,7 @@
%mp_deletefolder(&rootdir)
@param path Unquoted path to the folder to delete.
@param [in] folder Unquoted path to the folder to delete.
<h4> SAS Macros </h4>
@li mf_getuniquename.sas

2
base/mp_dictionary.sas
View File

@@ -29,7 +29,7 @@
![](https://user-images.githubusercontent.com/4420615/188278365-2987db97-0594-4a39-ac81-dbacdef5cdc8.png)
@param lib= (WORK) The libref in which to create the views
@param [in] lib= (WORK) The libref in which to create the views
<h4> Related Files </h4>
@li mp_dictionary.test.sas

10
base/mp_distinctfmtvalues.sas
View File

@@ -7,11 +7,11 @@
%mp_distinctfmtvalues(libds=sashelp.class,var=age,outvar=age,outds=test)
@param libds input dataset
@param var variable to get distinct values for
@param outvar variable to create. Default: `formatted_value`
@param outds dataset to create. Default: work.mp_distinctfmtvalues
@param varlen length of variable to create (default 200)
@param [in] libds= () input dataset
@param [in] var= (0) variable to get distinct values for
@param [out] outvar= (formatteed_value) variable to create.
@param [out] outds= (work.mp_distinctfmtvalues) dataset to create.
@param [in] varlen= (2000) length of variable to create
@version 9.2
@author Allan Bowe

16
base/mp_ds2ddl.sas
View File

@@ -1,8 +1,20 @@
/**
@file
@brief A wrapper for mp_getddl.sas
@details In the next release, this will be the main version.
@brief Fetches DDL for a specific table
@details Uses mp_getddl under the hood
@param [in] libds library.dataset to create ddl for
@param [in] fref= (getddl) the fileref to which to _append_ the DDL. If it
does not exist, it will be created.
@param [in] flavour= (SAS) The type of DDL to create. Options:
@li SAS
@li TSQL
@param [in]showlog= (NO) Set to YES to show the DDL in the log
@param [in] schema= () Choose a preferred schema name (default is to use
actual schema, else libref)
@param applydttm= (NO) For non SAS DDL, choose if columns are created with
native datetime2 format or regular decimal type
<h4> SAS Macros </h4>
@li mp_getddl.sas

4
base/mp_dsmeta.sas
View File

@@ -49,8 +49,8 @@
https://support.sas.com/resources/papers/proceedings14/1549-2014.pdf) by
[Louise Hadden](https://www.linkedin.com/in/louisehadden/).
@param libds The library.dataset to export the metadata for
@param outds= (work.dsmeta) The output table to contain the metadata
@param [in] libds The library.dataset to export the metadata for
@param [out] outds= (work.dsmeta) The output table to contain the metadata
<h4> Related Files </h4>
@li mp_dsmeta.test.sas

10
base/mp_filtercheck.sas
View File

@@ -37,10 +37,12 @@
@param [in] targetds= The target dataset against which to verify VARIABLE_NM.
This must be available (ie, the library must be assigned).
@param [out] abort= (YES) If YES will call mp_abort.sas on any exceptions
@param [out] outds= The output table, which is a copy of the &inds. table
plus a REASON_CD column, containing only bad records. If bad records found,
the SYSCC value will be set to 1008 (general data problem). Downstream
processes should check this table (and return code) before continuing.
@param [out] outds= (work.badrecords) The output table, which is a copy of the
&inds. table plus a REASON_CD column, containing only bad records.
If bad records are found, the SYSCC value will be set to 1008
(a general data problem).
Downstream processes should check this table (and return code) before
continuing.
<h4> SAS Macros </h4>
@li mp_abort.sas

4
base/mp_filtergenerate.sas
View File

@@ -51,8 +51,8 @@
> )
@param [in] inds The input table with query values
@param [out] outref= The output fileref to contain the filter clause. Will
be created (or replaced).
@param [out] outref= (filter) The output fileref to contain the filter clause.
Will be created (or replaced).
<h4> Related Macros </h4>
@li mp_filtercheck.sas

7
base/mp_filterstore.sas
View File

@@ -44,9 +44,10 @@
mp_coretable.sas as follows: `mp_coretable(LOCKTABLE)`.
@param [in] maxkeytable= (0) Optional permanent reference table used for
retained key tracking. Described in mp_retainedkey.sas.
@param [in] mdebug= set to 1 to enable DEBUG messages
@param [out] outresult= The result table with the FILTER_RK
@param [out] outquery= The original query, taken as extract after table load
@param [in] mdebug= (1) set to 1 to enable DEBUG messages
@param [out] outresult= (work.result) The result table with the FILTER_RK
@param [out] outquery= (work.query) The original query, taken as extract
after table load
<h4> SAS Macros </h4>

3
base/mp_getcols.sas
View File

@@ -20,6 +20,9 @@
|`DATE `|`8 `|`1 `|`DATE `|`MONYY `|`MONYY. `|`N `|`DATE `|
|`REGION `|`3 `|`3 `|`REGION `|` `|`$3. `|`C `|`CHARACTER `|
@param [in] ds The dataset to get the columns from
@param [out] outds= (work.cols) The dataset to create
<h4> Related Macros </h4>
@li mf_getvarlist.sas
@li mm_getcols.sas

8
base/mp_getdbml.sas
View File

@@ -23,10 +23,10 @@
@li mf_getquotedstr.sas
@li mp_getconstraints.sas
@param liblist= Space seperated list of librefs to take as
input (Default=SASHELP)
@param outref= Fileref to contain the DBML (Default=getdbml)
@param showlog= set to YES to show the DBML in the log (Default is NO)
@param [in] liblist= (SASHELP) Space seperated list of librefs to take as
input
@param [out] outref= (getdbml) Fileref to contain the DBML
@param [in] showlog= (NO) set to YES to show the DBML in the log
@version 9.3
@author Allan Bowe

25
base/mp_getddl.sas
View File

@@ -22,16 +22,21 @@
@li mf_getvarcount.sas
@li mp_getconstraints.sas
@param lib libref of the library to create DDL for. Should be assigned.
@param ds dataset to create ddl for (optional)
@param fref= the fileref to which to _append_ the DDL. If it does not exist,
it will be created.
@param flavour= The type of DDL to create (default=SAS). Supported=TSQL
@param showlog= Set to YES to show the DDL in the log
@param schema= Choose a preferred schema name (default is to use actual schema
,else libref)
@param applydttm= for non SAS DDL, choose if columns are created with native
datetime2 format or regular decimal type
@param [in] libref Libref of the library to create DDL for. Should already
be assigned.
@param [in] ds dataset to create ddl for (optional)
@param [in] fref= (getddl) the fileref to which to _append_ the DDL. If it
does not exist, it will be created.
@param [in] flavour= (SAS) The type of DDL to create. Options:
@li SAS
@li TSQL
@param [in]showlog= (NO) Set to YES to show the DDL in the log
@param [in] schema= () Choose a preferred schema name (default is to use
actual schema, else libref)
@param applydttm= (NO) For non SAS DDL, choose if columns are created with
native datetime2 format or regular decimal type
@version 9.3
@author Allan Bowe
**/

2
base/mp_guesspk.sas
View File

@@ -18,7 +18,7 @@
%mp_guesspk(sashelp.class,outds=classpks)
@param [in] baseds The dataset to analyse
@param [out] outds= The output dataset to contain the possible PKs
@param [out] outds= (mp_guesspk) Output dataset to contain the possible PKs
@param [in] max_guesses= (3) The total number of possible primary keys to
generate. A table may have multiple (unlikely) PKs, so no need to list them
all.

2
base/mp_hashdataset.sas
View File

@@ -24,7 +24,7 @@
@li mp_hashdirectory.sas
@param [in] libds dataset to hash
@param [in] salt= Provide a salt (could be, for instance, the dataset name)
@param [in] salt= () Provide a salt (could be, for instance, the dataset name)
@param [in] iftrue= (1=1) A condition under which the macro should be executed
@param [out] outds= (work._data_) The output dataset to create. This
will contain one column (hashkey) with one observation (a $hex32.

14
base/mp_lib2cards.sas
View File

@@ -24,19 +24,19 @@
@li mf_trimstr.sas
@li mp_ds2cards.sas
@param [in] lib= Library in which to convert all datasets
@param [out] outloc= Location in which to store output. Defaults to WORK
library. No quotes.
@param [out] outfile= Optional output file NAME - if provided, then will create
a single output file instead of one file per input table.
@param [in] maxobs= limit output to the first <code>maxobs</code> observations
@param [in] lib= () Library in which to convert all datasets
@param [out] outloc= (%sysfunc(pathname(work))) Location in which to store
output. No quotes.
@param [out] outfile= (0) Optional output file NAME - if provided, then
will create a single output file instead of one file per input table.
@param [in] maxobs= (max) limit output to the first <code>maxobs</code> rows
@version 9.2
@author Allan Bowe
**/
%macro mp_lib2cards(lib=
,outloc=%sysfunc(pathname(work)) /* without trailing slash */
,outloc=%sysfunc(pathname(work))
,maxobs=max
,random_sample=NO
,outfile=0

4
base/mp_md5.sas
View File

@@ -28,8 +28,8 @@
@li Global option: `options dsoptions=nonote2err;`
@li Data step option: `data YOURLIB.YOURDATASET /nonote2err;`
@param cvars= Space seperated list of character variables
@param nvars= Space seperated list of numeric variables
@param cvars= () Space seperated list of character variables
@param nvars= () Space seperated list of numeric variables
<h4> Related Programs </h4>
@li mp_init.sas

6
base/mp_perflog.sas
View File

@@ -11,9 +11,9 @@
%mp_perflog(finished)
@param label Provide label to go into the control dataset
@param libds= Provide a dataset in which to store performance stats. Default
name is <code>work.mp_perflog</code>;
@param [in] label Provide label to go into the control dataset
@param [in] libds= (work.mp_perflog) Provide a dataset in which to store
performance stats. Default name is <code>work.mp_perflog</code>;
@version 9.2
@author Allan Bowe

10
base/mp_prevobs.sas
View File

@@ -34,12 +34,12 @@
Credit is made to `data _null_` for authoring this very helpful paper:
https://www.lexjansen.com/pharmasug/2008/cc/CC08.pdf
@param action Either FETCH a current or previous record, or INITialise.
@param record The relative (to current) position of the previous observation
@param [in] action Either FETCH a current or previous record, or INITialise.
@param [in] record The relative (to current) position of the previous row
to return.
@param history= The number of records to retain in the hash table. Default=5
@param prefix= the prefix to give to the variables used to store the hash name
and index. Default=mp_prevobs
@param [in] history= (5) The number of records to retain in the hash table.
@param prefix= (mp_prevobs) The prefix to give to the variables used to
store the hash name and index.
@version 9.2
@author Allan Bowe

13
base/mp_recursivejoin.sas
View File

@@ -23,12 +23,13 @@
,childvar=c
)
@param base_ds= base table containing hierarchy (not modified)
@param outds= the output dataset to create with the generated hierarchy
@param matchval= the ultimate parent from which to filter
@param parentvar= name of the parent variable
@param childvar= name of the child variable (should be same type as parent)
@param mdebug= set to 1 to prevent temp tables being dropped
@param [in] base_ds= base table containing hierarchy (not modified)
@param [out] outds= the output dataset to create with the generated hierarchy
@param [in] matchval= the ultimate parent from which to filter
@param [in] parentvar= name of the parent variable
@param [in] childvar= () name of the child variable (should be same type as
parent)
@param [in] mdebug= set to 1 to prevent temp tables being dropped
@returns outds contains the following variables:

9
base/mp_replace.sas
View File

@@ -32,10 +32,11 @@
Note - if you are running a version of SAS that will allow the io package in
LUA, you can also use this macro: mp_gsubfile.sas
@param infile The QUOTED path to the file on which to perform the substitution
@param findvar= Macro variable NAME containing the string to search for
@param replacevar= Macro variable NAME containing the replacement string
@param outfile= (0) Optional QUOTED path to the adjusted output file (to
@param [in] infile The QUOTED path to the file on which to perform the
substitution
@param [in] findvar= Macro variable NAME containing the string to search for
@param [in] replacevar= Macro variable NAME containing the replacement string
@param [out] outfile= (0) Optional QUOTED path to the adjusted output file (to
avoid overwriting the first file).
<h4> SAS Macros </h4>

6
base/mp_runddl.sas
View File

@@ -31,9 +31,9 @@
%mp_runddl(/some/rootlib, exc=LIBREF3) * same as above ;
@param path location of the DDL folder structure
@param inc= list of librefs to include
@param exc= list of librefs to exclude (takes precedence over inc=)
@param [in] path location of the DDL folder structure
@param [in] inc= list of librefs to include
@param [in] exc= list of librefs to exclude (takes precedence over inc=)
@version 9.3
@author Allan Bowe

6
base/mp_searchcols.sas
View File

@@ -9,12 +9,12 @@
%mp_searchcols(libs=sashelp work, cols=name sex age)
@param libs=(SASHELP) Space separated list of libraries to search for columns
@param libs= (SASHELP) Space separated list of libraries to search for columns
@param cols= Space separated list of column names to search for (not case
sensitive)
@param outds=(mp_searchcols) the table to create with the results. Will have
@param outds= (mp_searchcols) the table to create with the results. Will have
one line per table match.
@param match=(ANY) The match type. Valid values:
@param match= (ANY) The match type. Valid values:
@li ANY - The table contains at least one of the columns
@li WILD - The table contains a column with a name that partially matches

7
base/mp_stprequests.sas
View File

@@ -21,9 +21,10 @@
%mp_stprequests(status_cd=INIT, libds=YOURLIB.DATASET )
@param status_cd= Use INIT for INIT and TERM for TERM events
@param libds= Location of base table (library.dataset). To minimise risk
of table locks, we HIGHLY recommend using a database (NOT a SAS dataset).
@param [in] status_cd= Use INIT for INIT and TERM for TERM events
@param [in] libds= (somelib.stp_requests) Location of base table
(library.dataset). To minimise risk of table locks, we HIGHLY recommend
using a database (NOT a SAS dataset).
THE LIBRARY SHOULD BE ASSIGNED ALREADY - eg in autoexec or earlier in the
init program proper.

4
base/mp_testjob.sas
View File

@@ -8,8 +8,8 @@
duration=60*5
)
@param [in] duration= the time in seconds which the job should run for. Actual
time may vary, as the check is done in between steps. Default = 30 (seconds).
@param [in] duration= (30) The time in seconds which the job should run for.
Actual time may vary, as the check is done in between steps.
<h4> SAS Macros </h4>
@li mf_getuniquelibref.sas

6
base/mp_testwritespeedlibrary.sas
View File

@@ -11,9 +11,9 @@
,outds=work.results
)
@param lib= (WORK) The library in which to create the table
@param size= (0.1) The size in GB of the table to create
@param outds= (WORK.RESULTS) The output dataset to be created.
@param [in] lib= (WORK) The library in which to create the table
@param [in] size= (0.1) The size in GB of the table to create
@param [out] outds= (WORK.RESULTS) The output dataset to be created.
<h4> SAS Macros </h4>
@li mf_getuniquename.sas

4
base/mp_tree.sas
View File

@@ -15,8 +15,8 @@ https://communities.sas.com/t5/SAS-Programming/listing-all-files-within-a-direct
https://communities.sas.com/t5/SAS-Programming/listing-all-files-of-all-types-from-all-subdirectories/m-p/334113/highlight/true#M75419
@param dir= Directory to be scanned (default=/tmp)
@param outds= Dataset to create (default=work.mp_tree)
@param [in] dir= (/tmp) Directory to be scanned
@param [out] outds= (work.mp_tree) Dataset to create
@returns outds contains the following variables:

9
base/mp_unzip.sas
View File

@@ -13,11 +13,12 @@
%mp_unzip(ziploc="/some/file.zip",outdir=/some/folder)
More info: https://blogs.sas.com/content/sasdummy/2015/05/11/using-filename-zip-to-unzip-and-read-data-files-in-sas/
More info:
https://blogs.sas.com/content/sasdummy/2015/05/11/using-filename-zip-to-unzip-and-read-data-files-in-sas/
@param ziploc= Fileref or quoted full path to zip file ("/path/to/file.zip")
@param outdir= (%sysfunc(pathname(work))) Directory in which to write the
outputs (created if non existant)
@param [in] ziploc= Fileref or quoted full path, eg: "/path/to/file.zip"
@param [out] outdir= (%sysfunc(pathname(work))) Directory in which to write
the outputs (created if needed)
<h4> SAS Macros </h4>
@li mf_mkdir.sas

6
base/mp_updatevarlength.sas
View File

@@ -14,9 +14,9 @@
proc sql;
describe table example;
@param libds the library.dataset to be modified
@param var The variable to modify
@param len The new length to apply
@param [in] libds the library.dataset to be modified
@param [in] var The variable to modify
@param [in] len The new length to apply
<h4> SAS Macros </h4>
@li mf_existds.sas

2
base/mp_wait4file.sas
View File

@@ -11,7 +11,7 @@
@param [in] file The file to wait for. Must be provided.
@param [in] maxwait= (0) Number of seconds to wait. If set to zero, will
loop indefinitely (to a maximum of 46 days, per SAS [documentation](
https://support.sas.com/documentation/cdl/en/lrdict/64316/HTML/default/viewer.htm#a001418809.htm
https://support.sas.com/documentation/cdl/en/lrdict/64316/HTML/default/viewer.htm#a001418809.htm
)). Otherwise, execution will proceed upon sleep expiry.
@param [in] interval= (1) The wait period between sleeps, in seconds

2
base/mp_webin.sas
View File

@@ -18,7 +18,7 @@
Usage:
%mp_webin()
%mp_webin()
This was created as a macro procedure (over a macro function) as it will also
use the filename statement in Viya environments (where `_webin_fileuri` is

10
base/mp_zip.sas
View File

@@ -15,14 +15,14 @@
<h4> SAS Macros </h4>
@li mp_dirlist.sas
@param in= unquoted filepath, dataset of files or directory to zip
@param type= (FILE) Valid values:
@param [in] in= unquoted filepath, dataset of files or directory to zip
@param [in] type= (FILE) Valid values:
@li FILE - /full/path/and/filename.extension to a particular file
@li DATASET - a dataset containing a list of files to zip (see `incol`)
@li DIRECTORY - a directory to zip
@param outname= (FILE) Output file to create, _without_ .zip extension
@param outpath= (%sysfunc(pathname(WORK))) Parent folder for output zip file
@param incol= if DATASET input, say which column contains the filepath
@param [out] outname= (FILE) Output file to create, _without_ .zip extension
@param [out] outpath= (%sysfunc(pathname(WORK))) Parent folder for zip file
@param [in] incol= () If DATASET input, say which column contains the filepath
<h4> Related Macros </h4>
@li mp_unzip.sas