index.listR Documentation

Generate an index from a list object

Description

Given a cell class create an index representation. If no source is specified no index will be generated.

Usage

## S3 method for class 'list'
index(object, id = "tangram", key.len = 4, ...)

Arguments

object

cell; The cell for indexing

id

character; an additional specifier for the object key

key.len

numeric; length of key to generate

...

additional arguments to renderer. Unused

Value

A list of strings containing key, source and value