Create a lexicographic index descriptor

Usage

lexicographicIndex(columns, name)

Arguments

columns
List of column names
name
Name to give the created lexicographic index; used when querying the GTable after it has been closed.

Value

a list that can be used as an index descriptor when calling newDXGTable

Description

Creates a lexicographic index descriptor describing which column(s) are to be used to create the index.

Examples

lexicographicIndex(list("quality"), "qualityIndex")
$name [1] "qualityIndex" $type [1] "lexicographic" $columns $columns[[1]] [1] "quality"
lexicographicIndex(list("quality", "othercol"), "multiColIndex")
$name [1] "multiColIndex" $type [1] "lexicographic" $columns $columns[[1]] [1] "quality" $columns[[2]] [1] "othercol"