builtin.ams {UCS}R Documentation

UCS/Perl Built-in Association Measures (base)

Description

builtin.ams returns a character vector listing the built-in association measures of the UCS/Perl system (including the standard add-on packages), is.builtin.am checks whether a specified measure belongs to this set, and am.key2desc returns a short description of the specified measure.

Usage

builtin.ams()

is.builtin.am(key)

am.key2desc(key)

Arguments

key a character vector specifying the names of one or more association measures

Value

builtin.ams returns a character vector containing the names of all built-in association measures, is.builtin.am returns a logical vector, and am.key2desc returns a character vector with a short description of each of the measures in key.

See Also

The information provided by these functions is obtained from the UCS/Perl tool ucs-list-am. See the ucsam manpage in UCS/Perl for further information about built-in association measures (using the shell command ucsdoc ucsam).

Examples

print(builtin.ams())
am.key2desc("chi.squared.corr")

[Package UCS version 0.5 Index]