Get correlation information

Get information about the correlation specifying for short name, long name or the name of the function.

get_z_correlations(how = "short")

Arguments

how	short: abbreviations; long: description; function: the name of the correlation function

Examples

# get the short name for the correlation
get_z_correlations(how = "short")
#> [1] "BB"  "HY"  "DAK" "DPR" "SH"  "N10" "PP" 

# get the description for the correlation
get_z_correlations(how = "long")
#> [1] "Beggs-Brill"              "Hall-Yarborough"         
#> [3] "Dranchuk-AbuKassem"       "Dranchuk-Purvis-Robinson"
#> [5] "Shell"                    "Ann10"                   
#> [7] "Papp"                    

# get the name of the function assgined to the correlation
get_z_correlations(how = "function")
#> [1] "z.BeggsBrill"             "z.HallYarborough"        
#> [3] "z.DranchukAbuKassem"      "z.DranchukPurvisRobinson"
#> [5] "z.Shell"                  "z.Ann10"                 
#> [7] "z.Papp"