Skip to contents

Draw growth chart

Source: R/draw_chart.R
draw_chart.Rd

The function draw_chart() plots individual data on the growth chart.

Usage

draw_chart(
  txt = "",
  session = "",
  format = "1.0",
  chartcode = "",
  selector = c("data", "derive", "chartcode"),
  chartgrp = NULL,
  agegrp = NULL,
  sex = NULL,
  etn = NULL,
  ga = NULL,
  side = "hgt",
  curve_interpolation = TRUE,
  quiet = FALSE,
  dnr = NULL,
  lo = NULL,
  hi = NULL,
  nmatch = 0L,
  exact_sex = TRUE,
  exact_ga = FALSE,
  break_ties = FALSE,
  show_realized = FALSE,
  show_future = FALSE,
  draw_grob = TRUE,
  loc = "",
  bds_data = "",
  ind_loc = "",
  ...
)

Arguments

txt

A JSON string, URL, or file with BDS data in JSON format. Data should conform to the BDS JGZ 3.2.5 specification.

session

OpenCPU session key with the uploaded data

format

JSON schema version, e.g., "3.0". Used when uploading.

chartcode

Optional. The code of the requested growth chart.

selector

Either "chartcode", "data" or "derive". The function can calculate the chart code by looking at the child data (method "data") or user input (method "derive"). More in detail, the following behaviour decides between growth charts:

"data"

Calculate chart code from the individual data. This setting chooses the "optimal" chart for a given individual set of data.

"derive"

Calculate chart code from a combination of user data: chartgrp, agegrp, side, sex, etn, ga. The method does not use individual data. Use this setting when chart choice needs to be reactive on user input.

"chartcode"

Take string specified in chartcode

If there is a valid tgt object, then the function simply obeys the selector setting. If no valid tgt object is found, the "chartcode" argument is taken. However, if the "chartcode" is empty, then the function selects method "derive".

chartgrp

The chart group: 'nl2010', 'preterm', 'who', 'gsed1', 'gsed1pt' or character(0)

agegrp

Either '0-15m', '0-4y', '1-21y', '0-21y' or '0-4ya'. Age group '0-4ya' provides the 0-4 chart with weight for age (design E).

sex

Either 'male' or 'female'

etn

Either 'netherlands', 'turkish', 'moroccan' or 'hindustani'

ga

Gestational age (in completed weeks)

side

Either 'front', 'back', '-hdc' or 'both'

curve_interpolation

A logical indicating whether curve interpolation shoud be applied.

quiet

Logical indicating whether chart code should be written to standard output. Default is quiet = TRUE.

dnr

Donor data, Prediction horizon: "0-2", "2-4" or "4-18". May also be "smocc", "lollypop", "terneuzen" or "pops". If not specified, then the choice is made internally.

lo

Value of the left visit coded as string, e.g. "4w" or "7.5m"

hi

Value of the right visit coded as string, e.g. "4w" or "7.5m"

nmatch

Integer. Number of matches needed. When nmatch == 0L no matches are sought.

exact_sex

A logical indicating whether sex should be matched exactly

exact_ga

A logical indicating whether gestational age should be matched exactly

break_ties

A logical indicating whether ties should broken randomly. The default (TRUE) breaks ties randomly.

show_realized

A logical indicating whether the realized growth of the target child should be drawn

show_future

A logical indicating whether the predicted growth of the target child should be drawn

draw_grob

Logical. Should chart be plotted on current device? Default is TRUE. For internal use only.

loc

Deprecated. Use session instead.

bds_data

Legacy. Will disappear in Nov 2022. Use txt instead.

ind_loc

Legacy. Will disappear in Nov 2022. Use loc instead.

...

Ignored

Value

A gTree object.

See also

select_chart()

Author

Stef van Buuren 2021

Examples

fn <- system.file("testdata", "client3.json", package = "james")
g <- draw_chart(txt = fn)

#> chartcode:  PMAHN27