---
title: "Overview of main functions"
output: 
  rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Overview of main functions}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---


```{r setup, include=FALSE}
old <- options(digits = 3)
knitr::opts_chunk$set(echo = TRUE, 
                      fig.width = 7, fig.height = 3,
                      dev = "png")
```

```{css css, echo = FALSE, include = FALSE, eval = FALSE}
img {
  border: 0px;
  padding: 10px;
}
```


## Objective

This vignette demonstrates three major functions in the `brokenstick` package: `brokenstick()`, `predict()` and `plot()`. We also need `dplyr` and `ggplot2`.

```{r message = FALSE, warning = FALSE}
require("brokenstick")
require("dplyr")
require("ggplot2")
```

For more elaborate documentation, see the [manual](../articles/manual/manual.html).

## Plot trajectories

The `smocc_200` data in the `brokenstick` package contain the heights of 200 Dutch children measured on 10 visits at ages 0-2 years. 

```{r smocc_200}
data <- brokenstick::smocc_200
head(data, 3)
```


```{r plotcm, echo = FALSE, fig.height=7, warning=FALSE}
ggplot(data[1:500, ], aes(x = age, y = hgt, group = id, color = as.factor(id))) +
  geom_line(size = 0.1) + 
  geom_point(size = 0.7) +
  scale_colour_viridis_d(option = "cividis") +
  xlab("Age (years)") +
  ylab("Length (cm)") +
  theme_light() +
  theme(legend.position = "none")
```

Figure 1 dispays the data from the first 500 rows as a set of growth curves of Dutch children. Curves are steeper during the first few months, so child growth is faster for young infants. Note also there are more cross-overs during the first half year, whereas fewer occur later. This means that the relative positions have been settled by the age of 2 years, or - put differently - that the correlation between time points at those ages is high.

```{r plotsds, fig.height=5, warning=FALSE}
ggplot(data[1:500, ], aes(x = age, y = hgt_z, group = id, color = as.factor(id))) +
  geom_line(size = 0.1) + 
  geom_point(size = 0.7) +
  scale_colour_viridis_d(option = "cividis") +
  xlab("Age (years)") +
  ylab("Length SDS") +
  theme_light() +
  theme(legend.position = "none")
```

Figure 2 dispays the same data, but with the vertical axis changed to Standard Deviation Scores (SDS), or $Z$-score. The $Z$-score is the height corrected for age relative to the Dutch height reference from the Fourth Dutch Growth Study. The $Z$-score transformation takes away the major time trend, so all curves are more or less flat. This allows us to see a more detailed assessment of individual growth.

The plots also show how the measurements are clustered around ten ages: birth, 1, 2, 3, 6, 9, 12, 15, 18 and 24 months. While the design was followed rigorously in the study, some variation in timing is inevitable because of weekends, holidays, sickness, and other events. The timing variation poses a problem because we cannot directly compare the measurement between different children (especially for figure 1). Also, we cannot easily construct the "broad" matrix with 10 time point per child. 

Of course, we can divide the time axis into ten age groups, and treat all point within the same age group as being measured at the same point. This is probably a good strategy for nicely looking data - as we have here -, but this approach is problematic in data with irregular time intervals, of there are multiple measurement per age group, if the measurement schedules vary by child, or in data combined from studies that employed different designs. 

The `brokenstick` package contains tools to approximate the observed data by a series of connecting straight lines. When these lines closely follow the data, we may replace each trajectory by its values at the breakpoints. The statistical analysis can then be done on the regularised trajectories, which is easier than working with the observed data.

## Fit broken stick model with one line

We fit a trivial broken stick model with just one line on ages between birth and two years, and plot the trajectories of three selected children as follows: 

```{r figure1, warning = FALSE}
set.seed(123)
fit <- brokenstick(hgt ~ age | id, data, knots = c(0, 2))
ids <- c(10001, 10005, 10022)
plot(fit, group = ids, 
     xlab = "Age (years)", ylab = "Length (cm)")
```

The following plot displays the same data, but in standardised units so as to increase the analytic resolution:

```{r zscore, warning = FALSE}
fit0 <- brokenstick(hgt_z ~ age | id, data, knots = c(0, 2))
plot(fit0, group = ids,
     xlab = "Age (years)", ylab = "Length (SDS)")
```

Note that both approximations describe the individual trend in the data, but do not address any systematic deviations from the trend.

## Fit broken stick model with two lines

The *broken stick model* describes a trajectory by a series of connected straight lines. We first calculate a model with two connected lines. The first line starts at birth and end at the age of exactly 1 years. The second line spans the period between 1 to 2 years. In addition, the lines must connect at the age of 1 year. We estimate and plot the model as follows:

```{r plotfit2, cache = TRUE, warning=FALSE}
fit2 <- brokenstick(hgt_z ~ age | id, data = data, knots = c(0, 1, 2))
plot(fit2, group = ids, xlab = "Age (years)", ylab = "Length (SDS)")
```

The plot shows that the two-line model is still fairly crude. The `fit2` object holds the parameter estimates of the model:

```{r}
summary(fit2)
```

The console output lists the knots of the model, including the left and right boundary knots at 0 and 2.6776. The row of `means` correspond to the fixed effect estimates of the linear mixed model. We may interpret these as the global means. Next, the output lists the variance-covariance matrix of the random effects. The model contains 16 parameters in total: four fixed effects (means), four random effects (diagonal elements), 6 covariance (off-diagonal elements) and 2 error variances (one for the residual error variance, one for the variability of the error per cluster). These parameters are enough to reconstruct the broken stick model, and to apply it to new data.

## Extend to nine lines

We refine the model in the first two years by adding a knot for each age at which a visit was scheduled. This model can be run as

```{r fit9, cache = TRUE, warning = FALSE}
knots <- round(c(0, 1, 2, 3, 6, 9, 12, 15, 18, 24)/12, 4)
fit9 <- brokenstick(hgt_z ~ age | id, data = data, knots = knots)
```

This optimization problem is more difficult, so it takes slightly longer to run. The results are


```{r}
summary(fit9)
```

There nine-line model summarises the data by 79 parameters. This model fits substantially better. The model residuals are substantially smaller (0.075 instead of 0.179) and the proportions of explained variance is much higher (0.983 instead of 0.867).

```{r plotfit9, echo = FALSE, warning = FALSE}
plot(fit9, group = ids, xlab = "Age (years)", ylab = "Length (SDS)")
```

The figure shows that the nine-line broken stick model fits the observed data very well.

## Obtain predicted values

The `predict()` function allows us to obtain various types of predictions from the broken stick model. The simplest call

```{r}
p1 <- predict(fit2)
head(p1)
identical(nrow(data), nrow(p1))
```

produces a `tibble` with the one column called `.pred` for each row in `data`. We can bind column `.pred` to `data` for further processing.

Sometimes, we also want the prediction at the knot values, for example, to create graphs that contain observed and modelled trajectories. We obtain predictions at the knots by the special `x = "knots"` argument, e.g.

```{r}
p2 <- predict(fit2, x = "knots", include_data = FALSE)
head(p2)
nrow(p2)
```

We use the `include_data = FALSE` argument to remove predictions for the observed data. The output is more verbose and includes the grid of knots for each child (`id`, `age`). The column `.source` is equal to `added` as all rows are non-observed data.

Note there are also knots at ages 0.00 and 2.68 years. These are boundary knots, and added by the `brokenstick()` function. The boundary knots effectively filter the observations that enter the calculations. By default, the boundary knots span the age range in the data. For technical reasons, the broken stick model also defines and estimates parameters for these knots, but these may in general be ignored, especially when the data near the boundary knots are sparse.

If we wish to obtain estimates at both the knots and the observed data use:

```{r}
p3 <- predict(fit2, x = "knots", hide = "none")
table(p3$.source)
```

This return 1942 rows for the data and 800 rows for the knots.

## Explained variance

The proportion of the variance of the outcome explained by the two-line model is

```{r}
get_r2(fit2)
```

For the second model we get

```{r}
get_r2(fit9)
```

so the nine-line broken stick model explains about `r round(100 * get_r2(fit9))` percent of the variance of the height SDS.


## Subject level analysis

Suppose we are interest in knowing the effect of sex, gestational age and birth weight on the height SDS at the age of 2 years. This is an analysis at the subject level. Let us first extract the subject-level data with variables that vary over subjects only.

```{r subjleveldata}
subj <- data %>%
  select(id, sex, ga, bw) %>% 
  group_by(id) %>% 
  slice(1)
head(subj, 3)
```

We also need the outcome variable. We take it from the broken stick estimates from the nine line solution and append it to the subject level data.

```{r predictatknots}
bs <- predict(fit9, x = "knots", shape = "wide", include_data = FALSE)
data <- bind_cols(subj, select(bs, -id))
head(data, 3)
```

The names of the columns in `bs` correspond to the knot values. 

The effect of the subject's sex, gestational age and birth weight on the height SDS at the age of 2 years (here denoted by the variable named `2`) can be estimated as 

```{r lm1}
fit1_lm <- lm(`2` ~ sex + ga + I(bw / 1000), data = data)
summary(fit1_lm)
```

Note that the analysis shows there is a substantial effect of birth weight. Of course, it might be that birth weight is directly related to height at the age of 2 years. Alternatively, the relation could be mediated by birth length. The following model adds birth length (the variable named `0`) to the model: 

```{r lm2}
fit2_lm <- lm(`2` ~ sex + ga + I(bw / 1000) + `0`, data = data)
summary(fit2_lm)
```

The effect of birth length on length at age 2 is very strong. There is no separate effect of birth weight anymore, so this analysis suggests that the relation between birth weight and length at age 2 can be explained by their mutual associations to birth length.

## Conclusion

This vignette illustrated the use of the `brokenstick()`, `plot()` and `predict()` functions. Other vignettes highlight various other capabilities of the package. 

```{r echo=FALSE}
options(old)
```

