check_hints {checkdown}R Documentation

Create list of hints for 'rmarkdown'

Description

Create list of hints for 'rmarkdown'

Usage

check_hints(
  hint_text,
  hint_title = "Click here to see/close the hint",
  hint_title_prefix = "",
  hint_title_suffix = "",
  list_title = "Click here to see/close the list of hints",
  type = c("onclick", "onmouseover", "ondblclick")
)

Arguments

hint_text

hint paragraph texts; can contain markdown

hint_title

hint title texts; can contain markdown

hint_title_prefix

string that added before each hint_title

hint_title_suffix

string that added after each hint_title

list_title

unique identifier for each hint

type

character that describes behavior of the hints. Possible values are: onclick, onmouseover, ondblclick

Value

returns the html tags and javascript code

Author(s)

George Moroz <agricolamz@gmail.com>

Examples


check_hints(1:4)


[Package checkdown version 0.0.12 Index]