reporter (version 1.2.6)

print.text_spec: Prints the text spec

Description

A function to print the text spec. The print function will print the text spec in summary form. To view all parameters, set the verbose parameter to TRUE.

Usage

# S3 method for text_spec
print(x, ..., verbose = FALSE)

Arguments

x

The text spec.

...

Additional parameters to pass to the underlying print function.

verbose

Whether to print in verbose form. Default is FALSE.

Value

The text spec, invisibly.

See Also

create_text function to create a text specification.

Other text: create_text()

Examples

# NOT RUN {
txt <- create_text("Lorem ipsum dolor sit amet, consectetur...",
                   align = "left", width = 3)
txt

# A text specification: 6 words
# - text: Lorem ipsum dolor sit amet, consectetur...
# - width: 3
# - align: left
# }