verbalise | R Documentation |
The description includes all pedigree paths between the two individuals,
indicating with brackets the topmost common ancestors in each path. See
print.pairrel()
for formatting options when printing the results.
verbalise(x, ids = leaves(x))
x |
A |
ids |
A vector containing the names of two pedigree members. |
An object of class pairrel
. This is essentially a list of lists,
containing many details about each path between the individuals. Most users
will not interact with this list directly, but simply use the description
provided by the print()
method.
print.pairrel()
.
# Example 1: Family quartet
x = nuclearPed(2)
verbalise(x, 1:2)
verbalise(x, 2:3)
verbalise(x, 3:4)
# Simplified output
verbalise(x, 2:3) |> print(simplify = TRUE)
# Example 2: Complicated cousin pedigree
y = doubleCousins(degree1 = 1, removal1 = 1, half1 = TRUE,
degree2 = 2, removal2 = 0, half2 = FALSE)
verbalise(y)
# Example 3: Full sib mating
z = fullSibMating(1)
verbalise(z)
verbalise(z, ids = c(1,5))
verbalise(z, ids = c(1,5)) |> print(simplify = TRUE)
# Example 4: Quad half first cousins
w = quadHalfFirstCousins()
verbalise(w)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.