---
title: Pedigree plotting details
author: TM Therneau, JP Sinnwell, Louis Le Nezet
date: '`r format(Sys.time(),"%d %B, %Y")`'
output:
    BiocStyle::html_document:
        toc: true
        toc_depth: 2
header-includes: \usepackage{tabularx}
vignette: |
    %\VignetteIndexEntry{Pedigree plotting details}
    %\VignetteEncoding{UTF-8}
    %\VignetteEngine{knitr::rmarkdown}
---

Introduction
==============

The plotting function for Pedigrees has 5 tasks

1. Gather information and check the data. An important step is the call
    to align.
2. Set up the plot region and size the symbols. The program wants to plot
    circles and squares, so needs to understand the geometry of the paper,
    Pedigree size, and text size to get the right shape and size symbols.
3. Set up the plot and add the symbols for each subject
4. Add connecting lines between spouses, and children with parents
5. Create an invisible return value containing the locations.

Another task, not yet completely understood, and certainly not implemented,
is how we might break a plot across multiple pages.

Setup
===========

The new version of the plotting Pedigree function works in two step.

- **`ped_to_plotdf()`** create a dataframe from a Pedigree given containing
all the necessary information to plot all the elements of the Pedigree:
"polygons", "text", "segments", "arcs"
- **`plot_from_df()`** use a given dataframe and plot all the element given

The advantage of this two step method, is that all the plotting can be
parralelised, each element can be customised by the user if necessary and
additional elements can also be added to the plot by just adding a new row.

If multiple families are present in the Pedigree object, then one dataframe per
family will be produced and the first one will be plotted.

For more informations about those two functions, see the help page.

- `help(ped_to_plotdf)`
- `help(plot_fromdf)`

Sizing
===============

Now we need to set the sizes. 
From `align()` we will get the maximum width and depth. 
There is one plotted row for each row of the returned matrices.
The number of columns of the matrices is the max width of the Pedigree,
so there are unused positions in shorter rows, these can be identifed
by having an nid value of 0.
Horizontal locations for each point go from 0 to xmax, subjects are at
least 1 unit apart; a large number will be exactly one unit part.
These locations will be at the top center of each plotted symbol.

## Set the graphical parameters

We would like to to make the boxes about 2.5 characters wide, which matches
most labels, but no more than 0.9 units wide or .5 units high.  
We also want to vertical room for the labels.
This is done by the `set_plot_area()` function.
We should have at least 1/2 of `stemp2` space above and `stemp2` space below.  
The `stemp3` variable is the height of labels: users may use multi-line ones.
Our constraints then are

1. $(box height + label height) \times maxlev \le height$ : the boxes and
    labels have to fit vertically
2. $(box height) \times (maxlev + (maxlev-1)/2) \le height$ : at least 1/2
    a box of space between each row of boxes
3. $(box width) \le stemp1$ in inches 
4. $(box width) \le 0.8$ unit in user coordinates, otherwise they appear 
    to touch
5. User coordinates go from $min(xrange)- 1/2 box width$ to 
    $max(xrange) + 1/2 box width$.
6. the box is square (in inches)

The first 3 of these are easy. The fourth comes into play only for very packed
pedigrees. Assume that the box were the maximum size of .8 units, i.e., minimal
spacing between them. Then $xmin -.45$ to $xmax + .45$ covers the plot region,
the scaling between user coordinates and inches is $(.8 + xmax-xmin)$
and the box is $.8 \times (figure width) / (.8 + xmax-xmin)$.
The transformation from user units to inches horizontally depends on the box
size, since we need to allow for 1/2 a box on the left and right.  
Vertically the range from 1 to nrow spans the tops of the symbols, which 
will be the figure region height less (the height of the text for the last
row + 1 box); remember that the coordinates point to the top center of the box.
We want row 1 to plot at the top, which is done by appropriate setting
of the usr parameter.

## Subsetting and Sub-Region

This section is still experimental and might change. Also, in the original
documentation by TM Therneau, it is within the sizing section above.

Sometimes a Pedigree is too large to fit comfortably on one page.
The `subregion` argument allows one to plot only a portion of the
Pedigree based on the plot region.  Along with other tools to
select portions of the Pedigree based on relatedness, such as all
the descendents of a particular marriage, it gives a tool for
addressing this. This breaks our original goal of completely
automatic plots, but users keep asking for more.

The argument is `subregion = c(min x, max x, min depth, max depth)`,
and works by editing away portions of the `plist` object
returned by align.  First decide what lines to keep. 
Then take subjects away from each line, update spouses and twins,
and fix up parentage for the line below.

`ped_to_plotdf()`
==================

This first function create the dataframe with the necessary plotting
information from a Pedigree object.
The steps are: 

1. Add boxes (depend on affection and sex) and marks.
2. Add deceased crossing if present.
3. Add id text and labels
3. Add in the connections, one by one, beginning with spouses.
4. Add connections children to parents.
5. Add lines/arcs to connect multiple instances of same subject.

## Details on the polygon filling and border

Each polygon is named based on its shape ("square", "circle","diamond",
"triangle"), the total number of division of the whole shape, and the
position of the division to plot.

```{r, polygons, fig.alt = "Different polygons"}
library(Pedixplorer)
types <- c(
    "square_1_1", # Whole square
    "circle_2_1", # Semi circle first division
    "diamond_3_2", # Third of diamond second division
    "triangle_4_3" # Fourth of triangle third division
)
df <- plot_df <- data.frame(
    x0 = c(1, 3, 5, 7), y0 = 1,
    type = types, fill = c("red", "blue", "green", "yellow"),
    border = "black",
    angle = c(NA, 90, 0, 45),
    density = c(NA, 10, 20, 40)
)
plot_fromdf(df, usr = c(0, 8, 0, 2))
```

The number of division will depend on the number of affection register in the
`fill` slot of the `scale` slot of the Pedigree.
The filling will depend on the color given by the corresponding modality for
each individual, it is the same for the border of the polygon.

## Details on connecting children to parents.

First there are lines up from each child, which would be trivial except for
twins, triplets, etc.
Then we draw the horizontal bar across siblings and finally the connector from
the parent.  For twins, the *vertical* lines are angled towards a 
common point, the variable is called *target* below.
The horizontal part is easier if we do things family by
family.  The `plist$twins` variable is 1/2/3 for a twin on my right,
0 otherwise.

## Details on arcs.

The last set of lines are dotted arcs that connect mulitiple instances of
a subject on the same line.  These instances may or may not be on the
same line.
The arrcconect function draws a quadratic arc between locations $(x1, y1)$
and $(x2, y2)$ whose height is 1/2 unit above a straight line connection.

`plot_fromdf()`
==================

## Polygons drawing

### Symbols

There are three main symbols corresponding to the three sex codes:
square = male, circle = female, diamond= unknown.
A triangle is use to represent miscarriage.
This triangle is crossed in the case of Termination of Pregnancy (TOB) contrary
to Spontaneous Abortion (SAB).  
They are shaded according to the value(s) of affected status for each
subject, and filling uses the standard
arguments of the `polygon()` function.
The complexity is when multiple affected status are given, in which case the
symbol will be divided up into sections, clockwise starting at the 
lower left. 
I asked Beth about this (original author) and there was no particular
reason to start at 6 o-clock, but it is now established as history.

The first part of the code is to create the collection of polygons that
will make up the symbol. These are then used again and again.
The collection is kept as a list with the four elements square, circle,
diamond and triangle.

Each of these is in turn a list with `max(fill(ped, "order"))` elements,
and each of those in turn a list of x and y coordinates.

### Circfun

The circle function is quite simple. The number of segments is arbitrary,
50 seems to be enough to make the eye happy. We draw the ray from 0 to
the edge, then a portion of the arc. The polygon function will connect
back to the center.

### Polyfun

Now for the interesting one --- dividing a polygon into ''pie slices''.
In computing this we can't use the usual $y= a + bx$ formula for a line,
because it doesn't work for vertical ones (like the sides of the square).
Instead we use the alternate formulation in terms of a dummy variable 
$z$.

\begin{eqnarray*}
    x &=& a + bz \\
    y &=& c + dz \\
\end{eqnarray*}

Furthermore, we choose the constants $a$, $b$, $c$, and $d$ so that 
the side of our polygon correspond to $0 \le z \le 1$.
The intersection of a particular ray at angle theta with a 
particular side will satisfy

\begin{eqnarray}
    theta &=& y/x = \frac{a + bz}{c+dz} \nonumber \\
    z &=& \frac{a\theta -c}{b - d\theta} \\
\end{eqnarray}

Equation $z$ will lead to a division by zero if the ray from the
origin does not intersect a side, e.g., a vertical divider will be parallel
to the sides of a square symbol. The only solutions we want have
$0 \le z \le 1$ and are in the ''forward''' part of the ray. This latter
is true if the inner product $x \cos(\theta) + y \sin(\theta) >0$.
Exactly one of the polygon sides will satisfy both conditions.

Final output and interactivness
================================

The Pedigree is plotted in a new frame or added to the current device.
If `ggplot_gen = TRUE`, then a ggplot object is create with the same
informations and available in the invisible object given back by
`plot_fromdf()*`

This ggplot object can be used to further customise the plot, add
annotations, or make it interactive. The `tips` argument can be used
to add tooltips to the plot. They will be displayed when hovering
over the corresponding element through the `text` element.

```{r, interactive_plot, fig.alt = "Interactive plot", eval = FALSE}
data(sampleped)
pedi <- Pedigree(sampleped)

p <- plot(
    pedi, ggplot_gen = TRUE,
    tips = c("affection", "momid", "dadid"),
    symbolsize = 1.5, cex = 0.8
)
plotly::layout(
    plotly::ggplotly(p$ggplot, tooltip = "text"),
    hoverlabel = list(bgcolor = "darkgrey")
)
```

    Notes:
        Remind the user of subjects who did not get
        plotted; these are ususally subjects who are married in but without
        children. Unless the Pedigree contains spousal information the
        routine does not know who is the spouse.
        Then restore the plot parameters.
        This would only not be done if someone wants to further annotate
        the plot.

Session information
===================

```{r}
sessionInfo()
```
