UtilityMacros

UtilityMacros.sas defines the following useful short macros utilized in most IEs and processes. You should %include UtilityMacros.sas at the beginning of any new process that you write, since it sets up several important macros and automatically runs the UtilInit macro.

%AddSuffixToDataName

This macro adds a suffix to a name.

%CheckAnno

This macro checks input parameters that correspond to annotation data.

%CheckBinary

This macro checks numeric variables to determine whether or not they are binary. Returns a value of 0 if all values are missing, 1 if there is a single value, 2 if there are two values, and 3 if there are three or more values.

%CheckBinaryChar

This macro checks numeric variable to determine whether or not they are binary. Returns a value of 0 if all values are missing, 1 if there is a single value, 2 if there are two values, and 3 if there are three or more values.

%CheckByVars

This macro screens out the precedent key word descending in a list of variables.

%CheckDataName

This macro checks whether a user-provided data name is a valid SAS data set name. If not, this macro modifies the data set name to a valid SAS data set name.

%CheckEndSlash

This macro checks a slash character for Windows or Linux operating systems.

%CheckExcel

This macro checks an Excel file and OS system.

%CheckForBlank

This macro checks whether the required input parameter is empty.

%CheckInData

This macro checks input data sets for compatibility with an experimental design data set.

%CheckJSL

This macro checks JSL names.

%CheckLabel

This macro checks whether the specified variable has an associated label.

%CheckLengthForMerging

This macro checks SAS variable lengths between two data sets to assure compatibility when merging.

%CheckListVarExist

This macro checks for the existence of a list of variables in a SAS data set.

%Checkrc

This macro checks the return code for a function.

%CheckVarExist

This macro checks for the existence of specified variables in a specified data set.

%ClockStart

This macro starts a timer.

%ClockStop

This macro stops a timer.

%ConvertFilePaths

This macro converts file paths between Windows and Linux.

%ConvertInputDataSet

This macro assigns a full path to a data set.

%ConvertInputFile

This macro assigns a full path to a file.

%CopySettingFile

This macro copies a setting file from an input folder to an output folder.

%ExitAndRetrieveLogLstFromJMP

This macro is run after a process to capture the SAS log and list file and perform final clean up.

%ExitSDSProcess

This macro performs ending tasks for a process.

%ExpandVars

This macro creates a list of variables separated by spaces. This macro is used for list-style specification of variables.

%FileFilter

This macro filters the files at a specified location and retains the filtered files in a data set.

%GetFileSize

This macro determines the size of a file.

%GetLevels

This macro extracts levels for a class variable.

%GetLineLoc

This macro extracts the physical starting location of the specified line in a text file.

%GetOrigFileName

This macro obtains and saves an original file name.

%GetVars

This macro extracts variables for a data set.

%GroupMacroVars

This macro is used to create various macro variables corresponding to a set of grouping variables.

%ImportScanRows

This macro modifies the number of scanning rows that are used for the IMPORT procedure (PROC IMPORT).

%LaunchExternalProgram

This macro launches an external program using Java.

%LaunchFile

This macro uses Java to launch each specified file.

%LaunchSASClean

This macro launches sasclean.jsl.

%MakeVarList

This macro creates a list of variables that contains a specified prefix from a given data set.

%MergeAnno

This macro merges annotation data into a SAS data set.

%Merge2sets

This macro merges two data sets using the specified merging keys.

%Naming

This macro checks the SAS variable naming convention for a given data set.

%NObsVars

This macro extracts the numbers of observations and variables for a given data set.

%PathName

This macro determines the path and file name from a full reference.

%PackageBegin

This macro starts a packaging process.

%PackageEnd

This macro finishes a packaging process.

%PackageInsertDataset

This macro inserts SAS data sets into a package.

%PackageInsertFile

This macro inserts files into a package.

%PackageInsertHtml

This macro inserts .html files into a package.

%PackagePublish

This macro binds and publishes packages.

%PrepHTML

This macro prepares .html output files.

%PrepOutFile

This macro prepares output text files.

%PrepOutDS

This macro prepares output data sets.

%PrintTimeFor

This macro prints the time.

%RemoveData

This macro removes a data set.

%RemoveFile

This macro removes/deletes a specified file.

%RemoveWord

This macro removes a word from a blank delimited string.

%RenameFIle

This macro uses Java to rename a file.

%Search_and_Replace

This macro searches a string for a word and replaces it with another.

%ShowTime

This macro writes the current day and time to the log with a prefixing message.

%Stack

This macro creates a stacked data set from the combination of a tall data set and an experimental design file.

%Stack_to_Tall

This macro creates a tall data set from a stacked data set.

%Sweep

This macro sweeps a symmetric matrix within a data step.

%TrimStringVariabe

This macro trims string variables to a specified length.

%UtilInit

This macro initializes several important macro variables and is run when %including UtilityMacros.sas.

%VarAttributes

This macro extracts the attributes (length and type) of the variables from an input file.