R/smocc_200.R

In brokenstick: Broken Stick Model for Irregular Longitudinal Data

#' Infant growth of 0-2 years, SMOCC data extract
#'
#' Longitudinal height and weight measurements during ages 0-2 years for a
#' representative sample of 1933 Dutch children born in 1988-1989. The dataset
#' \code{smocc_200} is sample of size 200 from the full data.
#'
#' @name smocc_200
#' @docType data
#' @format A tibble with 1942 rows and 7 columns:
#' \describe{
#' \item{id}{ID, unique \code{id} of each child (numeric)}
#' \item{age}{Decimal age, 0-2.68 years (numeric)}
#' \item{sex}{Sex, \code{"male"} or \code{"female"} (character)}
#' \item{ga}{Gestational age, completed weeks (numeric)}
#' \item{bw}{Birth weight in grammes (numeric)}
#' \item{hgt}{Height measurement in cm (numeric)}
#' \item{hgt_z}{Height in SDS relative Fourth Dutch Growth Study 1997 (numeric)}}
#' @source Herngreen WP, van Buuren S, van Wieringen JC, Reerink JD,
#'   Verloove-Vanhorick SP & Ruys JH (1994). Growth in length and weight from
#'   birth to 2 years of a representative sample of Netherlands children (born
#'   in 1988-89) related to socio-economic status and other background
#'   characteristics. \emph{Annals of Human Biology}, \bold{21}, 449-463.
#' @keywords datasets
NULL

#' Broken stick model with nine lines for 200 children
#'
#' Object `fit_200` has class `brokenstick` and
#' contains the fitted broken stick model, including the training data and
#' diagnostics.
#'
#' @name fit_200
#' @docType data
#' @format An object of class [brokenstick][brokenstick-class], fitted by the
#'   [brokenstick()].
#'
#' @details
#' The dataset was constructed as
#' ```{r eval=FALSE}
#' knots <- round(c(0, 1, 2, 3, 6, 9, 12, 15, 18, 24)/12, 4)
#' fit_200 <- brokenstick(hgt_z ~ age | id, data = smocc_200,
#'                        knots = knots, seed = 1)
#' ```
#' @keywords datasets
NULL

#' Broken stick model with nine lines for 200 children (light)
#'
#' Object `fit_200_light` has class `brokenstick` and stores the
#' the model settings and parameter estimates.
#'
#' @name fit_200_light
#' @docType data
#' @format An object of class [brokenstick][brokenstick-class], fitted by the
#'   [brokenstick()].
#'
#' @details
#' The datasets was constructed as
#' ```{r eval=FALSE}
#' knots <- round(c(0, 1, 2, 3, 6, 9, 12, 15, 18, 24)/12, 4)
#' fit_200_light <- brokenstick(hgt_z ~ age | id, data = smocc_200,
#'                        knots = knots,
#'                        light = TRUE, seed = 1)
#' ```
#' @keywords datasets
NULL