odfCat: Concatenate and Print in Native ODF

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/odfCat.R

Description

Outputs the objects, concatenating the representations, and sandwiches the output between XML tags.

Usage

1
2
3
odfCat(..., sep = " ", trim = FALSE, 
       digits = max(3, getOption("digits") - 3), nsmall = 0,
       width = NULL, na.encode = TRUE, scientific = NA)

Arguments

...

R objects (see Details for the types of objects allowed).

sep

character string to insert between the objects to print.

trim

used to convert numeric data to character using format

digits

used to convert numeric data to character using format

nsmall

used to convert numeric data to character using format

width

used to convert numeric data to character using format

na.encode

used to convert numeric data to character using format

x

scientific

used to convert numeric data to character using format

Details

odfCat is an analog to cat and is useful for producing output in user-defined functions. It converts its arguments to character strings, concatenates them, separating them by the given 'sep=' string. It then sandwiches the text between <text:p> tags, and then outputs them. Note that this will produce paragraphs and cannot sequentially produce sentences within a paragraph.

cat uses an internal function, so there will be some differences between cat and odfCat. For example, factors are naively converted to character and numeric data are converted to character.

Since the text is embedded in ODF tags escaped characters (e.g. \n) don't have any effect. Exceptions are single- and double-quotes.

The paragraph uses the current paragraph style. The document formatting.odt in the package's examples directory illustrates the process of changing the appearance of the paragraph.

Value

a character strng of class odfCat

Author(s)

Max Kuhn

See Also

cat, format

Examples

1
2
3
odfCat("\"hello world\"")
odfCat("these are the first letters", letters[1:5])
odfCat("some random normal data:", rnorm(5))

odfWeave documentation built on May 30, 2017, 7:23 a.m.