sds: Calculate SDS values. You can transform the resulting SDS...

Description Usage Arguments Value Examples

View source: R/lmsUtils.R

Description

Calculate SDS values. You can transform the resulting SDS values to a p-value by calling pnorm(). If you provide SDS values, y values will be returned instead.

Usage

1
2
3
4
5
6
7
8
9
sds(
  x,
  y,
  sex = "male",
  measurement = "height",
  ref = GrowthSDS::kromeyerHauschild,
  refName,
  recodeSex
)

Arguments

x

x value of the subject (e.g. (gestational) age)

y

y value of the subject (e.g. height)

sex

sex of the subject

measurement

measurement from which y originates

ref

Reference object to be used to calculate the SDS, defaults to kromeyerHauschild either ref or refName must be given

refName

name of the reference to be used to calculate the SDS values

recodeSex

list containing a mapping for sex to available sexes of the reference

Value

SDS value

Examples

1
2
3
4
5
6
7
sds(
  x   = 0,
  y   = 47,
  sex = 1,
  measurement = 'height',
  recodeSex   = list(`1` = 'male', `2` = 'female')
)

CrescNet/GrowthSDS documentation built on Feb. 4, 2021, 5:40 p.m.