While the info_tabular() and info_columns() functions allow us to add/modify info text for specific sections, the info_section() makes it possible to add sections of our own choosing and the information that make sense for those sections. Define a section_name and provide a series of named arguments (in the form entry_name = "The *info text*.") to build the informational content for that section.

info_section(x, section_name, ...)

Arguments

x

An informant object of class ptblank_informant.

section_name

The name of the section for which this information pertains.

...

Information entries as a series of named arguments. The names refer to subsection titles within the section defined as section_name and the RHS is the info text (informational text that can be written as Markdown and further styled with Text Tricks).

Value

A ptblank_informant object.

Details

The info text readily accepts Markdown formatting. Also, there are a few Text Tricks that are good to know. Markdown links written as < link url > or [ link text ]( link url ) will get nicely-styled links. Any dates expressed in the ISO-8601 standard with parentheses, "(2004-12-01)", will be styled with a font variation (monospaced) and underlined in purple. Spans of text can be converted to label text by using: (1) double parentheses around text for a rectangular label as in ((label text)), or (2) triple parentheses around text for a rounded-rectangular label like (((label text))). Finally, CSS styles can be applied to spans of info text with the following form:

[[ info text ]]<< CSS style rules >>

As an example of this in practice suppose you'd like to change the color of some text to red and make the font appear somewhat thinner. A variation on the following might be used:

"This is a [[factor]]<<color: red; font-weight: 300;>> value."

Figures

Function ID

3-3

See also

Other Information Functions: info_columns(), info_snippet(), info_tabular(), snip_highest(), snip_list(), snip_lowest(), snip_stats()

Examples

# Create a pointblank `informant` # object with `create_informant()`; # we specify a `read_fn` with the # `~` followed by a statement that # gets the `small_table` dataset informant <- create_informant( read_fn = ~ small_table, tbl_name = "small_table", label = "An example." ) # The `informant` object has the 'table' # and 'columns' sections; we can create # entirely different sections with their # own properties using `info_section()` informant <- informant %>% info_section( section_name = "notes", creation = "Dataset generated on (2020-01-15).", usage = "`small_table %>% dplyr::glimpse()`" ) # Upon printing the `informant` object, we see # the addition of the 'Notes' section and its # own information # The `informant` object can be written to # a YAML file with the `yaml_write()` # function; then, information can # be directly edited or modified # yaml_write( # informant = informant, # filename = "informant.yml" # ) # The YAML file can then be read back # into an informant object with the # `yaml_read_informant()` function # informant <- # yaml_read_informant( # filename = "informant.yml" # )