All functions
A full listing of functions available in Analytics, organized alphabetically or by category.
Functions in alphabetical order
Function | Description |
---|---|
Returns the absolute value of a numeric expression. The absolute value of a number is the number without its sign. |
|
Returns the age, in days, of a specified date compared to a specified cutoff date, or the current operating system date. |
|
Returns a string with leading and trailing spaces removed from the input string. |
|
Returns the ASCII code for a specified character. |
|
Returns a number specifying the starting location of a particular occurrence of a substring within a character value. |
|
Returns a logical value indicating whether the specified value falls within a range. |
|
Returns Unicode character data converted from ZONED or EBCDIC character data. Abbreviation for "Binary to String". |
|
Returns the binary representation for the specified byte position in the current record as an eight character string. |
|
Returns a string containing a specified number of blank spaces. |
|
Returns the character stored in the specified byte position in the current record. |
|
Returns the name of the day of the week for a specified date or datetime. Abbreviation for "Character Day of Week". |
|
Returns the character associated with the specified ASCII code. |
|
Replaces the first invalid character in a string, and all subsequent characters, with blanks. |
|
Returns the name of the month of the year for a specified date or datetime. Abbreviation for "Character Month of Year". |
|
Returns the cosine of an angle expressed in radians, with a precision of 15 decimal places. |
|
Converts a character or numeric date value to a date. Can also extract the date from a character or numeric datetime value and return it as a date. Abbreviation for "Character to Date". |
|
Converts a character or numeric datetime value to a datetime. Abbreviation for "Character to Datetime". |
|
Converts a character or numeric time value to a time. Can also extract the time from a character or numeric datetime value and return it as a time. Abbreviation for "Character to Time". |
|
Returns the cumulative interest paid on a loan during a range of periods. |
|
Returns the cumulative principal paid on a loan during a range of periods. |
|
Extracts the date from a specified date or datetime and returns it as a character string. Can also return the current operating system date. |
|
Converts a datetime to a character string. Can also return the current operating system datetime. |
|
Extracts the day of the month from a specified date or datetime and returns it as a numeric value (1 to 31). |
|
Returns the Unicode character located at the specified byte position in a record. |
|
Returns a value, or the result of a numeric expression, with the specified number of decimal places. |
|
Converts a Unicode string to a hexadecimal string. |
|
Returns the Dice's coefficient of two specified strings, which is a measurement of how similar the two strings are. |
|
Returns the upper or lower digit of a specified Packed data type byte. |
|
Returns a numeric value (1 to 7) representing the day of the week for a specified date or datetime. Abbreviation for "Day of Week". |
|
Converts an Analytics date value to a Unicode string in the specified language and locale format. Abbreviation for "Date to Unicode". |
|
Returns a string that has been converted to EBCDIC character encoding. |
|
Returns the effective annual interest rate on a loan. |
|
Returns the date of the last day of the month that is the specified number of months before or after a specified date. |
|
Returns a string that excludes the specified characters. |
|
Returns the exponential value (base 10) of a numeric expression with a specified number of decimal places. |
|
Returns the size of the specified file in bytes or -1 if the file does not exist. |
|
Returns a logical value indicating whether the specified string is present in a particular field, or anywhere in an entire record. |
|
Returns a logical value indicating whether any string in a set of one or more specified strings is present in a particular field, or anywhere in an entire record. |
|
Returns the expected Benford frequency for sequential leading positive numeric digits to a precision of eight decimal places. |
|
Returns a character identifying the data category of a field or variable, or the type of an Analytics project item. |
|
Returns the future value of a series of payments calculated using a constant interest rate. Future value is the sum of the payments plus the accumulated compound interest. |
|
Returns the future value of a current lump sum calculated using a constant interest rate. |
|
Returns the future value of a current lump sum calculated using a series of interest rates. |
|
Returns the current setting for the specified Analytics option (Options dialog box setting). |
|
Returns the date that is the specified number of months before or after a specified date. |
|
Returns a salted cryptographic hash value based on the input value. |
|
Converts an ASCII string to a hexadecimal string. |
|
Extracts the hour from a specified time or datetime and returns it as a numeric value using the 24-hour clock. |
|
Converts a hexadecimal string to a Unicode string. Abbreviation for "Hexadecimal to Unicode". |
|
Returns a string that includes only the specified characters. |
|
Returns the original string with specified text inserted at a specific byte location. |
|
Returns the integer value of a numeric expression or field value. |
|
Returns the interest paid on a loan for a single period. |
|
Returns a logical value indicating whether the input value is blank. |
|
Returns T (true) if the specified field or variable is defined, and F (false) otherwise. |
|
Returns a logical value indicating whether a string is a fuzzy duplicate of a comparison string. |
|
Returns a specified number of characters from the end of a string. |
|
Returns a string containing a specified number of leading digits. |
|
Returns the number of characters in a string. |
|
Returns the Levenshtein distance between two specified strings, which is a measurement of how much the two strings differ. |
|
Returns the logarithm (base 10) of a numeric expression or field value with a specified number of decimal places. |
|
Returns a string with alphabetic characters converted to lowercase. |
|
Returns a string with leading spaces removed from the input string. |
|
Returns a logical value indicating if a character string matches a specified format string containing wildcard characters, literal characters, or both. |
|
Performs a bitwise AND operation on the first bytes of two character strings. |
|
Returns a logical value indicating whether the specified value matches any of the values it is compared against. |
|
Returns the maximum value in a set of numeric values, or the most recent value in a set of datetime values. |
|
Returns the minimum value in a set of numeric values, or the oldest value in a set of datetime values. |
|
Extracts the minutes from a specified time or datetime and returns it as a numeric value. |
|
Returns the remainder from dividing two numbers. |
|
Extracts the month from a specified date or datetime and returns it as a numeric value (1 to 12). |
|
Returns the nominal annual interest rate on a loan. |
|
Returns the probability that a random variable from a normally distributed data set is less than or equal to a specified value, or exactly equal to a specified value. |
|
Returns the z-score associated with a specified probability in a standard normal distribution. The z-score is the number of standard deviations a value is from the mean of a standard normal distribution. |
|
Returns the current operating system time as a Datetime data type. |
|
Returns the number of periods required to pay off a loan. |
|
Returns a count of the number of times a substring occurs in a specified character value. |
|
Returns the value of a field with the starting position offset by a specified number of bytes. |
|
Returns a string with one or more specified substrings removed. |
|
Returns numeric data converted to the Packed data type. |
|
Returns the value of pi to 15 decimal places. |
|
Returns the amount of the periodic payment (principal + interest) required to pay off a loan. |
|
Returns the principal paid on a loan for a single period. |
|
Returns a string with the first character of each word set to uppercase and the remaining characters set to lowercase. |
|
Returns properties information for the specified Analytics project item. |
|
Returns the present value of a series of future payments calculated using a constant interest rate. Present value is the current, lump-sum value. |
|
Returns the present value required to generate a specific future lump sum calculated using a constant interest rate. Present value is the current, lump-sum value. |
|
PYDATE( ) |
Returns a date value calculated by a function in a external Python script. Data processing in Python is external to Analytics. |
PYDATETIME( ) |
Returns a datetime value calculated by a function in an external Python script. Data processing in Python is external to Analytics. |
PYLOGICAL( ) |
Returns a logical value calculated by a function in an external Python script. Data processing in Python is external to Analytics. |
PYNUMERIC( ) |
Returns a numeric value calculated by a function in an external Python script. Data processing in Python is external to Analytics. |
PYSTRING( ) |
Returns a character value calculated by a function in an external Python script. Data processing in Python is external to Analytics. |
PYTIME( ) |
Returns a time value calculated by a function in an external Python script. Data processing in Python is external to Analytics. |
Returns a random number that falls within a specified boundary. |
|
Returns the interest rate per period. |
|
RDATE( ) |
Returns a date value calculated by an R function or script. Data processing in R is external to Analytics. |
RDATETIME( ) |
Returns a datetime value calculated by an R function or script. Data processing in R is external to Analytics. |
Returns the length of the current record. |
|
Returns the current record number. |
|
Returns a field value from a record that is a specified number of records from the current record. |
|
Returns a logical value indicating whether the pattern specified by a regular expression occurs in a string. |
|
Replaces all instances of strings matching a regular expression with a new string. |
|
Returns a string that includes only the specified characters. |
|
Returns a string that repeats a substring a specified number of times. |
|
Replaces all instances of a specified character string with a new character string. |
|
Returns a string with the characters in reverse order. |
|
Returns a right-justified string the same length as a specified string, with any trailing spaces moved to the left of the string. |
|
RLOGICAL( ) |
Returns a logical value calculated by an R function or script. Data processing in R is external to Analytics. |
RNUMERIC( ) |
Returns a numeric value calculated by an R function or script. Data processing in R is external to Analytics. |
Returns the square root of a numeric expression. |
|
Returns a rounded whole number for a numeric value. |
|
RSTRING( ) |
Returns a string value calculated by an R function or script. Data processing in R is external to Analytics. |
RTIME( ) |
Returns a time value calculated by an R function or script. Data processing in R is external to Analytics. |
Extracts the seconds from a specified time or datetime and returns it as a numeric value. |
|
Returns a single character string with the bits in the first character of the input value shifted to the left or right. |
|
Returns the sine of an angle expressed in radians, with a precision of 15 decimal places. |
|
Returns the soundex code for the specified string, which can be used for phonetic comparisons with other strings. |
|
Returns a logical value indicating whether a string phonetically matches a comparison string. |
|
Returns a specified segment from a string. |
|
Converts a serial date – that is, a date expressed as an integer – to a date value. Abbreviation for "Serial to Date". |
|
Converts a serial datetime – that is, a datetime expressed as an integer, and a fractional portion of 24 hours – to a datetime value. Abbreviation for "Serial to Datetime". |
|
Converts a serial time – that is, a time expressed as a fractional portion of 24 hours, with 24 hours equaling 1 – to a time value. Abbreviation for "Serial to Time". |
|
Converts a numeric value to a character string. |
|
Returns a specified substring from a string. |
|
Returns the tangent of an angle expressed in radians, with a precision of 15 decimal places. |
|
Returns a logical value indicating whether a specified string occurs at a specific byte position in a record. |
|
Extracts the time from a specified time or datetime and returns it as a character string. Can also return the current operating system time. |
|
Returns the current operating system date as a Datetime data type. |
|
Reverses the display order of bi-directional text within a specified string. |
|
Returns a string with trailing spaces removed from the input string. |
|
Returns numeric data converted to the Unsigned data type. |
|
Returns a string with alphabetic characters converted to uppercase. |
|
Converts a Unicode string containing a formatted date to an Analytics date value. Abbreviation for "Unicode to Date". |
|
Converts a character string to a numeric value. |
|
Returns a logical value indicating whether the data in a physical data field is valid. |
|
Returns the number of workdays between two dates. |
|
Extracts the year from a specified date or datetime and returns it as a numeric value using the YYYY format. |
|
Converts numeric data to character data and adds leading zeros to the output. |
|
Returns the standard Z-statistic. |
Search, replace
Function | Description |
---|---|
Returns a number specifying the starting location of a particular occurrence of a substring within a character value. |
|
Returns a logical value indicating whether the specified value falls within a range. |
|
Replaces the first invalid character in a string, and all subsequent characters, with blanks. |
|
Returns a logical value indicating whether the specified string is present in a particular field, or anywhere in an entire record. |
|
Returns a logical value indicating whether any string in a set of one or more specified strings is present in a particular field, or anywhere in an entire record. |
|
Returns a logical value indicating whether the input value is blank. |
|
Returns a logical value indicating if a character string matches a specified format string containing wildcard characters, literal characters, or both. |
|
Returns a logical value indicating whether the specified value matches any of the values it is compared against. |
|
Returns a count of the number of times a substring occurs in a specified character value. |
|
Returns a logical value indicating whether the pattern specified by a regular expression occurs in a string. |
|
Replaces all instances of strings matching a regular expression with a new string. |
|
Replaces all instances of a specified character string with a new character string. |
|
Returns a logical value indicating whether a specified string occurs at a specific byte position in a record. |
Comparison
Function | Description |
---|---|
Returns the Dice's coefficient of two specified strings, which is a measurement of how similar the two strings are. |
|
Returns a logical value indicating whether a string is a fuzzy duplicate of a comparison string. |
|
Returns the Levenshtein distance between two specified strings, which is a measurement of how much the two strings differ. |
|
Returns the soundex code for the specified string, which can be used for phonetic comparisons with other strings. |
|
Returns a logical value indicating whether a string phonetically matches a comparison string. |
Conversion
Function | Description |
---|---|
Returns Unicode character data converted from ZONED or EBCDIC character data. Abbreviation for "Binary to String". |
|
Converts a character or numeric date value to a date. Can also extract the date from a character or numeric datetime value and return it as a date. Abbreviation for "Character to Date". |
|
Converts a character or numeric datetime value to a datetime. Abbreviation for "Character to Datetime". |
|
Converts a character or numeric time value to a time. Can also extract the time from a character or numeric datetime value and return it as a time. Abbreviation for "Character to Time". |
|
Extracts the date from a specified date or datetime and returns it as a character string. Can also return the current operating system date. |
|
Converts a datetime to a character string. Can also return the current operating system datetime. |
|
Converts an Analytics date value to a Unicode string in the specified language and locale format. Abbreviation for "Date to Unicode". |
|
Returns a string that has been converted to EBCDIC character encoding. |
|
Returns a salted cryptographic hash value based on the input value. |
|
Returns numeric data converted to the Packed data type. |
|
Converts a serial date – that is, a date expressed as an integer – to a date value. Abbreviation for "Serial to Date". |
|
Converts a serial datetime – that is, a datetime expressed as an integer, and a fractional portion of 24 hours – to a datetime value. Abbreviation for "Serial to Datetime". |
|
Converts a serial time – that is, a time expressed as a fractional portion of 24 hours, with 24 hours equaling 1 – to a time value. Abbreviation for "Serial to Time". |
|
Converts a numeric value to a character string. |
|
Extracts the time from a specified time or datetime and returns it as a character string. Can also return the current operating system time. |
|
Returns numeric data converted to the Unsigned data type. |
|
Converts a Unicode string containing a formatted date to an Analytics date value. Abbreviation for "Unicode to Date". |
|
Converts a character string to a numeric value. |
|
Converts numeric data to character data and adds leading zeros to the output. |
Text
Function | Description |
---|---|
Returns a string with leading and trailing spaces removed from the input string. |
|
Returns Unicode character data converted from ZONED or EBCDIC character data. Abbreviation for "Binary to String". |
|
Returns a string containing a specified number of blank spaces. |
|
Converts a datetime to a character string. Can also return the current operating system datetime. |
|
Converts an Analytics date value to a Unicode string in the specified language and locale format. Abbreviation for "Date to Unicode". |
|
Returns a string that has been converted to EBCDIC character encoding. |
|
Returns a string that excludes the specified characters. |
|
Returns a string that includes only the specified characters. |
|
Returns the original string with specified text inserted at a specific byte location. |
|
Returns a specified number of characters from the end of a string. |
|
Returns the number of characters in a string. |
|
Returns a string with alphabetic characters converted to lowercase. |
|
Returns a string with leading spaces removed from the input string. |
|
Returns a string with one or more specified substrings removed. |
|
Returns a string with the first character of each word set to uppercase and the remaining characters set to lowercase. |
|
Returns a string that includes only the specified characters. |
|
Returns a string that repeats a substring a specified number of times. |
|
Returns a string with the characters in reverse order. |
|
Returns a right-justified string the same length as a specified string, with any trailing spaces moved to the left of the string. |
|
Returns a specified segment from a string. |
|
Converts a numeric value to a character string. |
|
Returns a specified substring from a string. |
|
Reverses the display order of bi-directional text within a specified string. |
|
Returns a string with trailing spaces removed from the input string. |
|
Returns a string with alphabetic characters converted to uppercase. |
|
Converts numeric data to character data and adds leading zeros to the output. |
Math
Function | Description |
---|---|
Returns the absolute value of a numeric expression. The absolute value of a number is the number without its sign. |
|
Returns the cosine of an angle expressed in radians, with a precision of 15 decimal places. |
|
Returns a value, or the result of a numeric expression, with the specified number of decimal places. |
|
Returns the exponential value (base 10) of a numeric expression with a specified number of decimal places. |
|
Returns the expected Benford frequency for sequential leading positive numeric digits to a precision of eight decimal places. |
|
Returns the integer value of a numeric expression or field value. |
|
Returns a string containing a specified number of leading digits. |
|
Returns the logarithm (base 10) of a numeric expression or field value with a specified number of decimal places. |
|
Returns the maximum value in a set of numeric values, or the most recent value in a set of datetime values. |
|
Returns the minimum value in a set of numeric values, or the oldest value in a set of datetime values. |
|
Returns the remainder from dividing two numbers. |
|
Returns the probability that a random variable from a normally distributed data set is less than or equal to a specified value, or exactly equal to a specified value. |
|
Returns the z-score associated with a specified probability in a standard normal distribution. The z-score is the number of standard deviations a value is from the mean of a standard normal distribution. |
|
Returns the value of pi to 15 decimal places. |
|
Returns a random number that falls within a specified boundary. |
|
Returns the square root of a numeric expression. |
|
Returns a rounded whole number for a numeric value. |
|
Returns the sine of an angle expressed in radians, with a precision of 15 decimal places. |
|
Returns the tangent of an angle expressed in radians, with a precision of 15 decimal places. |
|
Converts a character string to a numeric value. |
|
Converts numeric data to character data and adds leading zeros to the output. |
|
Returns the standard Z-statistic. |
Date and time
Function | Description |
---|---|
Returns the age, in days, of a specified date compared to a specified cutoff date, or the current operating system date. |
|
Returns the name of the day of the week for a specified date or datetime. Abbreviation for "Character Day of Week". |
|
Returns the name of the month of the year for a specified date or datetime. Abbreviation for "Character Month of Year". |
|
Converts a character or numeric date value to a date. Can also extract the date from a character or numeric datetime value and return it as a date. Abbreviation for "Character to Date". |
|
Converts a character or numeric datetime value to a datetime. Abbreviation for "Character to Datetime". |
|
Converts a character or numeric time value to a time. Can also extract the time from a character or numeric datetime value and return it as a time. Abbreviation for "Character to Time". |
|
Extracts the date from a specified date or datetime and returns it as a character string. Can also return the current operating system date. |
|
Converts a datetime to a character string. Can also return the current operating system datetime. |
|
Extracts the day of the month from a specified date or datetime and returns it as a numeric value (1 to 31). |
|
Returns a numeric value (1 to 7) representing the day of the week for a specified date or datetime. Abbreviation for "Day of Week". |
|
Returns the date of the last day of the month that is the specified number of months before or after a specified date. |
|
Returns the date that is the specified number of months before or after a specified date. |
|
Extracts the hour from a specified time or datetime and returns it as a numeric value using the 24-hour clock. |
|
Returns the maximum value in a set of numeric values, or the most recent value in a set of datetime values. |
|
Returns the minimum value in a set of numeric values, or the oldest value in a set of datetime values. |
|
Extracts the minutes from a specified time or datetime and returns it as a numeric value. |
|
Extracts the month from a specified date or datetime and returns it as a numeric value (1 to 12). |
|
Returns the current operating system time as a Datetime data type. |
|
Extracts the seconds from a specified time or datetime and returns it as a numeric value. |
|
Converts a serial date – that is, a date expressed as an integer – to a date value. Abbreviation for "Serial to Date". |
|
Converts a serial datetime – that is, a datetime expressed as an integer, and a fractional portion of 24 hours – to a datetime value. Abbreviation for "Serial to Datetime". |
|
Converts a serial time – that is, a time expressed as a fractional portion of 24 hours, with 24 hours equaling 1 – to a time value. Abbreviation for "Serial to Time". |
|
Extracts the time from a specified time or datetime and returns it as a character string. Can also return the current operating system time. |
|
Returns the current operating system date as a Datetime data type. |
|
Converts a Unicode string containing a formatted date to an Analytics date value. Abbreviation for "Unicode to Date". |
|
Returns the number of workdays between two dates. |
|
Extracts the year from a specified date or datetime and returns it as a numeric value using the YYYY format. |
Financial
Function | Description |
---|---|
Returns the cumulative interest paid on a loan during a range of periods. |
|
Returns the cumulative principal paid on a loan during a range of periods. |
|
Returns the effective annual interest rate on a loan. |
|
Returns the future value of a series of payments calculated using a constant interest rate. Future value is the sum of the payments plus the accumulated compound interest. |
|
Returns the future value of a current lump sum calculated using a constant interest rate. |
|
Returns the future value of a current lump sum calculated using a series of interest rates. |
|
Returns the interest paid on a loan for a single period. |
|
Returns the nominal annual interest rate on a loan. |
|
Returns the number of periods required to pay off a loan. |
|
Returns the amount of the periodic payment (principal + interest) required to pay off a loan. |
|
Returns the principal paid on a loan for a single period. |
|
Returns the present value of a series of future payments calculated using a constant interest rate. Present value is the current, lump-sum value. |
|
Returns the present value required to generate a specific future lump sum calculated using a constant interest rate. Present value is the current, lump-sum value. |
|
Returns the interest rate per period. |
Field and record
Function | Description |
---|---|
Returns a character identifying the data category of a field or variable, or the type of an Analytics project item. |
|
Returns a salted cryptographic hash value based on the input value. |
|
Returns T (true) if the specified field or variable is defined, and F (false) otherwise. |
|
Returns the value of a field with the starting position offset by a specified number of bytes. |
|
Returns the length of the current record. |
|
Returns the current record number. |
|
Returns a field value from a record that is a specified number of records from the current record. |
|
Returns a logical value indicating whether the data in a physical data field is valid. |
Table, file, and project
Function | Description |
---|---|
Returns the size of the specified file in bytes or -1 if the file does not exist. |
|
Returns a character identifying the data category of a field or variable, or the type of an Analytics project item. |
|
Returns the current setting for the specified Analytics option (Options dialog box setting). |
|
Returns properties information for the specified Analytics project item. |
Variable testing
Function | Description |
---|---|
Returns a character identifying the data category of a field or variable, or the type of an Analytics project item. |
|
Returns T (true) if the specified field or variable is defined, and F (false) otherwise. |
Python
Function | Description |
---|---|
PYDATE( ) |
Returns a date value calculated by a function in a external Python script. Data processing in Python is external to Analytics. |
PYDATETIME( ) |
Returns a datetime value calculated by a function in an external Python script. Data processing in Python is external to Analytics. |
PYLOGICAL( ) |
Returns a logical value calculated by a function in an external Python script. Data processing in Python is external to Analytics. |
PYNUMERIC( ) |
Returns a numeric value calculated by a function in an external Python script. Data processing in Python is external to Analytics. |
PYSTRING( ) |
Returns a character value calculated by a function in an external Python script. Data processing in Python is external to Analytics. |
PYTIME( ) |
Returns a time value calculated by a function in an external Python script. Data processing in Python is external to Analytics. |
R
Function | Description |
---|---|
RDATE( ) |
Returns a date value calculated by an R function or script. Data processing in R is external to Analytics. |
RDATETIME( ) |
Returns a datetime value calculated by an R function or script. Data processing in R is external to Analytics. |
RLOGICAL( ) |
Returns a logical value calculated by an R function or script. Data processing in R is external to Analytics. |
RNUMERIC( ) |
Returns a numeric value calculated by an R function or script. Data processing in R is external to Analytics. |
RSTRING( ) |
Returns a string value calculated by an R function or script. Data processing in R is external to Analytics. |
RTIME( ) |
Returns a time value calculated by an R function or script. Data processing in R is external to Analytics. |
Bit and character encoding
Function | Description |
---|---|
Returns the ASCII code for a specified character. |
|
Returns the binary representation for the specified byte position in the current record as an eight character string. |
|
Returns the character stored in the specified byte position in the current record. |
|
Returns the character associated with the specified ASCII code. |
|
Returns the Unicode character located at the specified byte position in a record. |
|
Converts a Unicode string to a hexadecimal string. |
|
Returns the upper or lower digit of a specified Packed data type byte. |
|
Converts an ASCII string to a hexadecimal string. |
|
Converts a hexadecimal string to a Unicode string. Abbreviation for "Hexadecimal to Unicode". |
|
Performs a bitwise AND operation on the first bytes of two character strings. |
|
Returns a single character string with the bits in the first character of the input value shifted to the left or right. |