index.default: Generate an index from a cell object

Description Usage Arguments Value

View source: R/render-index.R

Description

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

Usage

1
2
3
## 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


tangram documentation built on June 5, 2018, 1:04 a.m.