print.pairrel: Format and print relationship descriptions

View source: R/print.R

print.pairrelR 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, 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.

includePaths

A logical indicating if the complete paths should be included in the output. By default TRUE.


verbalisr documentation built on June 26, 2024, 5:08 p.m.