anchors: Anchor Information

View source: R/anchors.R

anchorsR Documentation

Anchor Information

Description

Retrieves diagnostics such as the anchor index and history. Use for code verification and troubleshooting. Also used internally by kfigr.

Usage

anchors(tag)

Arguments

tag

Optional specification of return type. tag = "index" returns a dataframe listing the chunk labels, asigned types and index numbers. tag = "history" returns a dataframe listing all reference calls, in order.

Value

If tag = "index", a dataframe listing all anchored chunks. If tag = "history", a dataframe listing all references made, in order. If the value of tag matches a specific type, all references of that type are provided in a list. If tag is missing, all references of all types are provided in a nested list.

Examples

figr("foo", type="figure")
figr("bar", type="table")
figr("test", type="figure")
anchors()


mkoohafkan/kfigr documentation built on Jan. 17, 2024, 1:12 a.m.