Update README

growthcharts · Mar 9, 2020 · e266b02 · e266b02
1 parent 05c658e
commit e266b02
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 50 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -24,7 +24,11 @@ Application of these tools helps to identify children that meet
 criteria for criteria for referral from youth health care (JGZ) for
 follow-up with a general physician or pediatrician.
 
-Dutch guidelines for unusual height growth are currently implemented.
+The current version implements Dutch guidelines for
+
+- height
+- weight
+- head circumference
 
 ## Installation
 
@@ -43,7 +47,7 @@ Find the advice for a very short girl:
 library(growthscreener)
 
 # a very short girl, 4 months old
-msgcode <- calculate_advice_hgt(sex = "F", etn = "N", 
+msgcode <- calculate_advice_hgt(sex = "female", etn = "N", 
                                 bw = 3250, ga = 40,
                                 dob = as.Date("2018-07-31"),
                                 dom1 = as.Date("2018-12-12"), 
@@ -52,19 +56,32 @@ msgcode
 cat(fold(msg(msgcode)))
 
 # some more details
-d <- calculate_helpers_hgt(sex = "F", etn = "N", 
-                           bw = 3250, ga = 40,
-                           dob = as.Date("2018-07-31"),
-                           dom1 = as.Date("2018-12-12"), 
-                           y1 = 55)
-d
+d <- calculate_helpers(yname = "hgt", 
+                       sex = "female", etn = "N", 
+                       bw = 3250, ga = 40,
+                       dob = as.Date("2018-07-31"),
+                       dom1 = as.Date("2018-12-12"), 
+                       y1 = 55)
+unlist(d)
 ```
 
-The height SDS at the age of 4 months is equal to -3.26, which is 
-the reason for referral. There are 40 different messages for height.
+The height SDS at the age of about 4 months is equal to -3.255, which is 
+the reason for referral.
 
 ## Background
 
-The calculations follow to the "JGZ-Richtlijn Lengtegroei 2019". See
-<https://www.ncj.nl/richtlijnen/alle-richtlijnen/richtlijn/lengtegroei-2019>
-for more details.
+The calculations implement several guidelines and guidelines:
+
+- **JGZ-Richtlijn Lengtegroei 2019**: <https://www.ncj.nl/richtlijnen/alle-richtlijnen/richtlijn/lengtegroei-2019>
+- **JGZ-Richtlijn Overgewicht 2012**: <https://www.ncj.nl/richtlijnen/alle-richtlijnen/richtlijn/overgewicht>
+- **JGZ-Richtlijn Ondergewicht 2019**: <https://www.ncj.nl/richtlijnen/alle-richtlijnen/richtlijn/ondergewicht-2019>
+- **Beslisboom Hoofdomtrek**: A decision tree for head circumference for children below the age of 1 year.
+
+There are 43 different messages for height, 21 messages for weight and 15 messages for head circumference. To see them all:
+
+```{r eval=FALSE}
+messages
+```
+
+
+
diff --git a/README.md b/README.md
@@ -13,7 +13,11 @@ tools helps to identify children that meet criteria for criteria for
 referral from youth health care (JGZ) for follow-up with a general
 physician or pediatrician.
 
-Dutch guidelines for unusual height growth are currently implemented.
+The current version implements Dutch guidelines for
+
+  - height
+  - weight
+  - head circumference
 
 ## Installation
 
@@ -30,57 +34,54 @@ Find the advice for a very short girl:
 
 ``` r
 library(growthscreener)
+#> Registered S3 method overwritten by 'pryr':
+#>   method      from
+#>   print.bytes Rcpp
 
 # a very short girl, 4 months old
-msgcode <- calculate_advice_hgt(sex = "F", etn = "N", 
+msgcode <- calculate_advice_hgt(sex = "female", etn = "N", 
                                 bw = 3250, ga = 40,
                                 dob = as.Date("2018-07-31"),
                                 dom1 = as.Date("2018-12-12"), 
                                 y1 = 55)
 msgcode
-#> [1] 45
+#> [1] 1045
 cat(fold(msg(msgcode)))
 #> Het advies volgens de JGZ-richtlijn lengtegroei is als volgt: Verwijzen naar
 #> huisarts/kinderarts, omdat de lengte < -3 SDS is en het geboortegewicht >= 2500
 #> gram is.
 
 # some more details
-d <- calculate_helpers_hgt(sex = "F", etn = "N", 
-                           bw = 3250, ga = 40,
-                           dob = as.Date("2018-07-31"),
-                           dom1 = as.Date("2018-12-12"), 
-                           y1 = 55)
-d
-#> $bw_z
-#> [1] -0.474
-#> 
-#> $bl_z
-#> [1] NA
-#> 
-#> $th
-#> [1] NA
-#> 
-#> $th_z
-#> [1] NA
-#> 
-#> $age1
-#> [1] 0.367
-#> 
-#> $age0
-#> [1] NA
-#> 
-#> $z1
-#> [1] -3.26
-#> 
-#> $z0
-#> [1] NA
+d <- calculate_helpers(yname = "hgt", 
+                       sex = "female", etn = "N", 
+                       bw = 3250, ga = 40,
+                       dob = as.Date("2018-07-31"),
+                       dom1 = as.Date("2018-12-12"), 
+                       y1 = 55)
+unlist(d)
+#>   bw_z   bl_z     th   th_z   age1   age0     z1     z0 
+#> -0.474     NA     NA     NA  0.367     NA -3.255     NA
 ```
 
-The height SDS at the age of 4 months is equal to -3.26, which is the
-reason for referral. There are 40 different messages for height.
+The height SDS at the age of about 4 months is equal to -3.255, which is
+the reason for referral.
 
 ## Background
 
-The calculations follow to the “JGZ-Richtlijn Lengtegroei 2019”. See
-<https://www.ncj.nl/richtlijnen/alle-richtlijnen/richtlijn/lengtegroei-2019>
-for more details.
+The calculations implement several guidelines and guidelines:
+
+  - **JGZ-Richtlijn Lengtegroei 2019**:
+    <https://www.ncj.nl/richtlijnen/alle-richtlijnen/richtlijn/lengtegroei-2019>
+  - **JGZ-Richtlijn Overgewicht 2012**:
+    <https://www.ncj.nl/richtlijnen/alle-richtlijnen/richtlijn/overgewicht>
+  - **JGZ-Richtlijn Ondergewicht 2019**:
+    <https://www.ncj.nl/richtlijnen/alle-richtlijnen/richtlijn/ondergewicht-2019>
+  - **Beslisboom Hoofdomtrek**: A decision tree for head circumference
+    for children below the age of 1 year.
+
+There are 43 different messages for height, 21 messages for weight and
+15 messages for head circumference. To see them all:
+
+``` r
+messages
+```