hmn24 / qutilityfunctions

Contains typical utils function (dynamic ones) to use in libs

QUtilityFunctions

Utility scripts to use in KDB processes

User Guide

a) qscripts/util_depTree.q

i) Display All Functions

Example:

.util.getAllInfo `f
.util.getAllInfo "f"

ii) Display All Tables

Example:

.util.getAllInfo `a
.util.getAllInfo "a"

iii) Tracing of Function Dependency Trees

Example: 

@param  regex       {symbol/string}     Regex to match the function spaces for  
@param  addFilter   {boolean}           Specifies if additional filter of "[(/[') ;@.]" to be appended to the regex specified
@param  isCase      {boolean}           Specifies if case sensitivity to the regex shall be applied

Can take up to three arguments, less than which, the addFilter and isCase args will default to 1b

.util.genDepTree[`.util.baseNS]             // With additional filter and case sensitivity 
.util.genDepTree[`.util.baseNS;0b]          // Without additional filter but case sensitivity
.util.genDepTree[`.util.baseNS;0b;0b]       // Without additional filter and case sensitivity

iv) Tracing of Single Regex Search

Example:

@param  regex       {symbol/string}     Regex to match the function spaces for  
@param  addFilter   {boolean}           Specifies if additional filter of "[(/[') ;@.]" to be appended to the regex specified
@param  isCase      {boolean}           Specifies if case sensitivity to the regex shall be applied

Can take up to three arguments, less than which, the addFilter and isCase args will default to 1b

.util.singleSearch[`.util.baseNS]             // With additional filter and case sensitivity 
.util.singleSearch[`.util.baseNS;0b]          // Without additional filter but case sensitivity
.util.singleSearch[`.util.baseNS;0b;0b]       // Without additional filter and case sensitivity

b) qscripts/util_html.q

i) Generation of verbose table meta information, i.e. dictionary of meta tables

Example: 

.util.getTabMeta[]

Additional Note:

.util.writeXlsTab[`test] to write the dictionary of meta tables generated above in xls format 

ii) Reverse xml (xls) files generated by .h.edsn

Example: 

.util.reverseEdsn[`test.xls]

c) HTML Interface

Initialisation Steps:

i) q html_startup.q

Initialises the q process with the relevant qutils scripts above, as well as initialise a standard port number of 5014

ii) Click on either html/qutils_meta.html or html/qutils_tree.html

This would load the relevant html pages for one to use the functions defined above easily