RCPCHGrowth CLI (Command-line Interface) tool¶
Partly for our own uses, we've wrapped the Python package in a command-line tool so that you can use the power of the growth functions in the rcpchgrowth-python
package conveniently in the terminal.
link
Installation¶
pip install rcpchgrowth-python-cli
Usage¶
Check that rcpchgrowth-python-cli
was correctly installed
rcpchgrowth --help
Should return some help text.
Calculating a decimal chronologic age¶
rcpchgrowth age-calculation [birth_date] [observation_date] \
[gestation_weeks] [gestation-days] [-a --adjustment]
This returns a decimal age representing the different between two dates.
If the gestation is supplied with the -a
adjustment flag, age will be returned, corrected for gestational age.
birth_date
: formatYYYY-MM-DD
(required)observation_date
: formatYYYY-MM-DD
(required)gestation_weeks
: this is an integer which defaults to 40 if not specifiedgestation_days
: this is an integer which defaults to 0 if not specified
Note the command line will usually error if a leading 0 is supplied.
Gestational Age Correction¶
If the -a
or --adjustment
flags are passed, gestational age correction will be performed to the supplied gestation in weeks and days, if nothing is passed, then gestational age correction will still be applied but it will use the default 40+0 weeks.
Example¶
The following calculates a decimal age for a child born on 10th October 1759 and measured on 12th November 1759, with genstational age correction for birth at 28 weeks 2 days.
rcpchgrowth age-calculation 1759-10-10 1759-11-12 28 2 -a
Below is the same calculation without gestational age correction
rcpchgrowth age-calculation 1759-10-10 1759-11-12 28 2
Generating measurements that fit a certain SDS¶
The measurement-for-sds
function returns a measurement for an SDS.
Required arguments (argument order sensitive)¶
- decimal_age: a float value
- measurement_method: one of 'height', 'weight', 'bmi' (body mass index) or 'ofc' (head circumference)
- sex: one of 'male' or 'female'
- SDS: a float value
Option¶
-r
--reference
This defaults to uk-who if not provided. If provide, parameters are one of 'uk-who', 'trisomy-21' or 'turners-syndrome'
Example¶
foo@bar:~$ rcpchgrowth measurement-for-sds 8.3 height female 0.72 --reference turners-syndrome
____ ____ ____ ____ _ _ ____ _ _
| _ \ / ___| _ \ / ___| | | |/ ___|_ __ _____ _| |_| |__
| |_) | | | |_) | | | |_| | | _| '__/ _ \ \ /\ / / __| '_ \
| _ <| |___| __/| |___| _ | |_| | | | (_) \ V V /| |_| | | |
|_| \_\\____|_| \____|_| |_|\____|_| \___/ \_/\_/ \__|_| |_|
Reference: Turner's Syndrome
SDS 0.72
Centile: 76.424 %
height: 115.79078818040003 cm
sds-for-measurement
¶
Required arguments (argument order sensitive)¶
- decimal_age: a float value
- measurement_method: one of 'height', 'weight', 'bmi' (body mass index) or 'ofc' (head circumference)
- sex: one of 'male' or 'female'
- observation_value: a float value
Option¶
-r
--reference
This defaults to uk-who if not provided. If provide, paramaters are one of 'uk-who', 'trisomy-21' or 'turners-syndrome'
Example¶
foo@bar:~$ rcpchgrowth sds-for-measurement 16.3 ofc female 55
____ ____ ____ ____ _ _ ____ _ _
| _ \ / ___| _ \ / ___| | | |/ ___|_ __ _____ _| |_| |__
| |_) | | | |_) | | | |_| | | _| '__/ _ \ \ /\ / / __| '_ \
| _ <| |___| __/| |___| _ | |_| | | | (_) \ V V /| |_| | | |
|_| \_\\____|_| \____|_| |_|\____|_| \___/ \_/\_/ \__|_| |_|
Reference: UK-WHO
SDS: -0.27811780457145885
Centile: 39.0 %
measurement-for-centile
¶
This function returns a measurement for an centile.
Required arguments (argument order sensitive)¶
- decimal_age: a float value
- measurement_method: one of 'height', 'weight', 'bmi' (body mass index) or 'ofc' (head circumference)
- sex: one of 'male' or 'female'
- centile: a float value
Option¶
-r
--reference
This defaults to uk-who if not provided. If provide, paramaters are one of 'uk-who', 'trisomy-21' or 'turners-syndrome'
Example¶
foo@bar:~$ rcpchgrowth measurement-for-centile 3.4 weight male 25.0 --reference trisomy-21
____ ____ ____ ____ _ _ ____ _ _
| _ \ / ___| _ \ / ___| | | |/ ___|_ __ _____ _| |_| |__
| |_) | | | |_) | | | |_| | | _| '__/ _ \ \ /\ / / __| '_ \
| _ <| |___| __/| |___| _ | |_| | | | (_) \ V V /| |_| | | |
|_| \_\\____|_| \____|_| |_|\____|_| \___/ \_/\_/ \__|_| |_|
Reference: Trisomy 21/Down's Syndrome
SDS -0.674
Centile: 25.0 %
weight: 12.367721906931306 kg
Development of the CLI tool¶
see Development