print.pairrel: Format and print relationship descriptions

In verbalisr: Describe Pedigree Relationships in Words

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 verbalise().
...	Arguments passed on to format.pairrel().
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 paste(..., collapse = collapse).
includePaths	A logical indicating if the complete paths should be included in the output. By default TRUE.

verbalisr documentation built on April 4, 2025, 1:36 a.m.