index.default: Generate an index from a cell object

View source: R/render-index.R

index.defaultR Documentation

Generate an index from a cell object

Description

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

Usage

## Default S3 method:
index(object, id = "tangram", name = NULL, key.len = 4, ...)

Arguments

object

cell; The cell for indexing

id

character; an additional specifier for the object key

name

character; optional names of elements inside object

key.len

numeric; length of generated key

...

additional arguments to renderer. Unused

Value

A list of strings containing key, source and value


spgarbet/tg documentation built on Feb. 21, 2023, 3:35 a.m.