hook_anchor: Anchor Chunk Hook Extension for package:knitr

Description Usage Arguments Details References See Also Examples

View source: R/hook_anchor.r

Description

knitr hook functions are called when the corresponding chunk options are not NULL to do additional jobs beside the R code in chunks. kfigr provides the hook "anchor" which adds an HTML anchor tag immediately above a code chunk.

Usage

1
hook_anchor(before, options, envir)

Arguments

before, options, envir

see references

Details

the function hook_anchor is set as a hook in knitr when kfigr is attached (and removed when kfigr is detached). It writes an HMTL anchor tag directly above a code chunk in the form <a name="chunk-name"></a> where chunk-name is the chunk label contained in options$label.

References

http://yihui.org/knitr/hooks#chunk-hooks

See Also

figr, anchors

Examples

1
2
3
4
5
6
## Not run: 
require(knitr)
knit_hooks$set(anchor = hook_anchor)
# then in code chunks, use e.g. the option anchor = "figure"

## End(Not run)

kfigr documentation built on June 10, 2021, 9:10 a.m.