print.pairrel {verbalisr} | R Documentation |
Format and print relationship descriptions
Description
This documents the options for formatting and printing the output of
verbalise()
.
Usage
## S3 method for class 'pairrel'
print(x, ...)
## S3 method for class 'pairrel'
format(
x,
cap = TRUE,
simplify = FALSE,
abbreviate = FALSE,
collapse = NULL,
includePaths = !simplify,
...
)
Arguments
x |
An output of |
... |
Arguments passed on to |
cap |
A logical indicating if the first letter of each path description should be capitalised. By default TRUE. |
simplify |
A logical. If TRUE, the descriptions of lineal and avuncular relationships are simplified. Default: FALSE. |
abbreviate |
A logical. It TRUE, various abbreviations are applied to the descriptions, e.g. 'great-great-' -> 'gg-' and 'once removed' -> '1r'. Default: FALSE. |
collapse |
A single string, or NULL. If given, and the relationship has
multiple descriptions, these are concatenated with |
includePaths |
A logical indicating if the complete paths should be included in the output. By default TRUE. |
[Package verbalisr version 0.7.1 Index]