docs: Update README to reflect that SAS benchmarking available

ropensci · Dec 14, 2024 · d3a2ad1 · d3a2ad1
1 parent 629a279
commit d3a2ad1
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 80 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -22,6 +22,21 @@ authors:
   given-names: Simon R
   email: simon.parker1471@outlook.com
   orcid: https://orcid.org/0009-0003-8214-4496
+preferred-citation:
+  type: manual
+  title: 'gigs: Assess Fetal, Newborn, and Child Growth with International Standards'
+  authors:
+  - family-names: Parker
+    given-names: Simon R
+    email: simon.parker1471@outlook.com
+    orcid: https://orcid.org/0009-0003-8214-4496
+  - family-names: Vesel
+    given-names: Linda
+  - family-names: Ohuma
+    given-names: Eric O
+  year: '2024'
+  notes: 0.4.1.9002
+  url: https://github.com/ropensci/gigs/
 repository-code: https://github.com/ropensci/gigs
 url: https://github.com/ropensci/gigs/
 contact:
@@ -330,21 +345,6 @@ references:
     email: garnier@njit.edu
   year: '2024'
   doi: 10.32614/CRAN.package.viridis
-- type: software
-  title: mfp
-  abstract: 'mfp: Multivariable Fractional Polynomials'
-  notes: Suggests
-  url: https://github.com/georgheinze/mfp/issues/
-  repository: https://CRAN.R-project.org/package=mfp
-  authors:
-  - family-names: Ambler
-    given-names: Gareth
-    email: gareth@stats.ucl.ac.uk
-  - family-names: Benner
-    given-names: Axel
-    email: benner@dkfz.de
-  year: '2024'
-  doi: 10.32614/CRAN.package.mfp
 - type: software
   title: tidyr
   abstract: 'tidyr: Tidy Messy Data'

diff --git a/README.Rmd b/README.Rmd
@@ -434,12 +434,10 @@ standards are implemented but not others.
 | `r zanthro`     | Stata    | `r yes`         | `r no`         | `r no`         | `r no`           | Values `r rarr` z-scores/centiles |
 | `r gigs_sas`    | SAS      | `r yes`         | `r yes`        | `r yes`        | `r yes`          | Values `r harr` z-scores/centiles |
 
-We have benchmarked these implementations (excluding **gigs** for SAS) against
-each other for conversion of values to z-scores in the WHO Child Growth
-Standards and different sets of `r intergrowth21st` standards. The table below
-shows the relative speed of each software package when processing 100,000
-inputs. The code used to generate these timings can be seen online in the
-**gigs** benchmarking
+We have benchmarked these implementations against each other for conversion of values to z-scores in the WHO Child Growth Standards and different sets of 
+`r intergrowth21st` standards. The table below shows the relative speed of each
+software package when processing 100,000 inputs. The code used to generate these
+timings can be seen online in the **gigs** benchmarking
 [article](https://ropensci.github.io/gigs/articles/benchmarking.html).
 
 | Software        | Platform | WHO (0-5 years) (ms)                      | `r ig21st` NBS (ms)                    | `r ig21st` PNG (ms)                    | `r ig21st` Fetal (ms)                   |

diff --git a/README.md b/README.md
@@ -270,29 +270,29 @@ and INTERGROWTH-21<sup>st</sup> project:
   Component standards
   </summary>
 
-  | Acronym   | Description                                                  | Unit | `x` range       |
-  |-----------|--------------------------------------------------------------|------|-----------------|
-  | `hcfga`   | head circumference-for-GA                                    | mm   | 98 to 280 days  |
-  | `bpdfga`  | biparietal diameter-for-GA                                   | mm   | 98 to 280 days  |
-  | `acfga`   | abdominal circumference-for-GA                               | mm   | 98 to 280 days  |
-  | `flfga`   | femur length-for-GA                                          | mm   | 98 to 280 days  |
-  | `ofdfga`  | occipito-frontal diameter for-GA                             | mm   | 98 to 280 days  |
-  | `efwfga`  | estimated fetal weight-for-GA                                | g    | 154 to 280 days |
-  | `sfhfga`  | symphisis-fundal height-for-GA                               | mm   | 112 to 294 days |
-  | `crlfga`  | crown-rump length-for-GA                                     | mm   | 58 to 105 days  |
-  | `gafcrl`  | GA-for-crown-rump length                                     | days | 15 to 95 mm     |
-  | `gwgfga`  | gestational weight gain-for-GA                               | kg   | 98 to 280 days  |
-  | `pifga`   | pulsatility index-for-GA                                     |      | 168 to 280 days |
-  | `rifga`   | resistance index-for-GA                                      |      | 168 to 280 days |
-  | `sdrfga`  | systolic/diastolic ratio-for-GA                              |      | 168 to 280 days |
-  | `tcdfga`  | transcerebellar diameter-for-GA                              | mm   | 98 to 280 days  |
-  | `tcdfga`  | GA-for-transcerebellar diameter                              | mm   | 98 to 280 days  |
-  | `poffga`  | parietal-occipital fissure-for-GA                            | mm   | 105 to 252 days |
-  | `sffga`   | Sylvian fissue-for-GA                                        | mm   | 105 to 252 days |
-  | `avfga`   | anterior horn of the lateral ventricle-for-GA                | mm   | 105 to 252 days |
-  | `pvfga`   | atrium of the posterior horn of the lateral ventricle-for-GA | mm   | 105 to 252 days |
-  | `cmfga`   | cisterna magna-for-GA                                        | mm   | 105 to 252 days |
-  | `hefwfga` | Hadlock estimated fetal weight-for-GA                        | g    | 126 to 287 days |
+  | Acronym | Description | Unit | `x` range |
+  |----|----|----|----|
+  | `hcfga` | head circumference-for-GA | mm | 98 to 280 days |
+  | `bpdfga` | biparietal diameter-for-GA | mm | 98 to 280 days |
+  | `acfga` | abdominal circumference-for-GA | mm | 98 to 280 days |
+  | `flfga` | femur length-for-GA | mm | 98 to 280 days |
+  | `ofdfga` | occipito-frontal diameter for-GA | mm | 98 to 280 days |
+  | `efwfga` | estimated fetal weight-for-GA | g | 154 to 280 days |
+  | `sfhfga` | symphisis-fundal height-for-GA | mm | 112 to 294 days |
+  | `crlfga` | crown-rump length-for-GA | mm | 58 to 105 days |
+  | `gafcrl` | GA-for-crown-rump length | days | 15 to 95 mm |
+  | `gwgfga` | gestational weight gain-for-GA | kg | 98 to 280 days |
+  | `pifga` | pulsatility index-for-GA |  | 168 to 280 days |
+  | `rifga` | resistance index-for-GA |  | 168 to 280 days |
+  | `sdrfga` | systolic/diastolic ratio-for-GA |  | 168 to 280 days |
+  | `tcdfga` | transcerebellar diameter-for-GA | mm | 98 to 280 days |
+  | `tcdfga` | GA-for-transcerebellar diameter | mm | 98 to 280 days |
+  | `poffga` | parietal-occipital fissure-for-GA | mm | 105 to 252 days |
+  | `sffga` | Sylvian fissue-for-GA | mm | 105 to 252 days |
+  | `avfga` | anterior horn of the lateral ventricle-for-GA | mm | 105 to 252 days |
+  | `pvfga` | atrium of the posterior horn of the lateral ventricle-for-GA | mm | 105 to 252 days |
+  | `cmfga` | cisterna magna-for-GA | mm | 105 to 252 days |
+  | `hefwfga` | Hadlock estimated fetal weight-for-GA | g | 126 to 287 days |
 
   </details>
 - `who_gs` - WHO Child Growth Standards for term infants
@@ -455,41 +455,41 @@ package, a red cross (❌) indicates that these standards are completely
 missing, and a warning sign (⚠️) indicates that some of these standards
 are implemented but not others.
 
-| Software                                                                            | Platform | WHO (0-5 years) | IG-21<sup>st</sup> NBS | IG-21<sup>st</sup> PNG | IG-21<sup>st</sup> Fetal | Functionality              |
-|-------------------------------------------------------------------------------------|----------|-----------------|------------------------|------------------------|--------------------------|----------------------------|
-| [gigs](https://www.github.com/ropensci/gigs/)                                       | R        | ✅              | ✅                     | ✅                     | ✅                       | Values ↔ z-scores/centiles |
-| [anthro](https://cran.r-project.org/web/packages/anthro/index.html)                 | R        | ✅              | ❌                     | ❌                     | ❌                       | Values → z-scores          |
-| [AGD](https://cran.r-project.org/web/packages/AGD/index.html)                       | R        | ✅              | ❌                     | ❌                     | ❌                       | Values ↔ z-scores          |
-| [childsds](https://cran.r-project.org/web/packages/childsds/index.html)             | R        | ✅              | ❌                     | ❌                     | ❌                       | Values → z-scores/centiles |
-| [ki-tools/growthstandards](https://www.github.com/ki-tools/growthstandards/)        | R        | ✅              | ✅                     | ⚠️                     | ⚠️                       | Values ↔ z-scores/centiles |
-| [nutriverse/intergrowth](https://github.com/nutriverse/intergrowth/)                | R        | ❌              | ❌                     | ❌                     | ⚠️                       | Values → z-scores/centiles |
-| [sitar](https://cran.r-project.org/web/packages/sitar/index.html)                   | R        | ✅              | ❌                     | ❌                     | ❌                       | Values ↔ z-scores/centiles |
-| [zscorer](https://cran.r-project.org/web/packages/zscorer/index.html)               | R        | ✅              | ❌                     | ❌                     | ❌                       | Values → z-scores/centiles |
-| [gigs](https://www.github.com/ropensci/gigs-stata/) (Stata)                         | Stata    | ✅              | ✅                     | ✅                     | ✅                       | Values ↔ z-scores/centiles |
-| [zanthro](https://journals.sagepub.com/doi/epdf/10.1177/1536867X1301300211) (Stata) | Stata    | ✅              | ❌                     | ❌                     | ❌                       | Values → z-scores/centiles |
-| [gigs](https://github.com/SASPAC/gigs/) (SAS)                                       | SAS      | ✅              | ✅                     | ✅                     | ✅                       | Values ↔ z-scores/centiles |
-
-We have benchmarked these implementations (excluding **gigs** for SAS)
-against each other for conversion of values to z-scores in the WHO Child
-Growth Standards and different sets of INTERGROWTH-21<sup>st</sup>
-standards. The table below shows the relative speed of each software
-package when processing 100,000 inputs. The code used to generate these
-timings can be seen online in the **gigs** benchmarking
+| Software | Platform | WHO (0-5 years) | IG-21<sup>st</sup> NBS | IG-21<sup>st</sup> PNG | IG-21<sup>st</sup> Fetal | Functionality |
+|----|----|----|----|----|----|----|
+| [gigs](https://www.github.com/ropensci/gigs/) | R | ✅ | ✅ | ✅ | ✅ | Values ↔ z-scores/centiles |
+| [anthro](https://cran.r-project.org/web/packages/anthro/index.html) | R | ✅ | ❌ | ❌ | ❌ | Values → z-scores |
+| [AGD](https://cran.r-project.org/web/packages/AGD/index.html) | R | ✅ | ❌ | ❌ | ❌ | Values ↔ z-scores |
+| [childsds](https://cran.r-project.org/web/packages/childsds/index.html) | R | ✅ | ❌ | ❌ | ❌ | Values → z-scores/centiles |
+| [ki-tools/growthstandards](https://www.github.com/ki-tools/growthstandards/) | R | ✅ | ✅ | ⚠️ | ⚠️ | Values ↔ z-scores/centiles |
+| [nutriverse/intergrowth](https://github.com/nutriverse/intergrowth/) | R | ❌ | ❌ | ❌ | ⚠️ | Values → z-scores/centiles |
+| [sitar](https://cran.r-project.org/web/packages/sitar/index.html) | R | ✅ | ❌ | ❌ | ❌ | Values ↔ z-scores/centiles |
+| [zscorer](https://cran.r-project.org/web/packages/zscorer/index.html) | R | ✅ | ❌ | ❌ | ❌ | Values → z-scores/centiles |
+| [gigs](https://www.github.com/ropensci/gigs-stata/) (Stata) | Stata | ✅ | ✅ | ✅ | ✅ | Values ↔ z-scores/centiles |
+| [zanthro](https://journals.sagepub.com/doi/epdf/10.1177/1536867X1301300211) (Stata) | Stata | ✅ | ❌ | ❌ | ❌ | Values → z-scores/centiles |
+| [gigs](https://github.com/SASPAC/gigs/) (SAS) | SAS | ✅ | ✅ | ✅ | ✅ | Values ↔ z-scores/centiles |
+
+We have benchmarked these implementations against each other for
+conversion of values to z-scores in the WHO Child Growth Standards and
+different sets of INTERGROWTH-21<sup>st</sup> standards. The table below
+shows the relative speed of each software package when processing
+100,000 inputs. The code used to generate these timings can be seen
+online in the **gigs** benchmarking
 [article](https://ropensci.github.io/gigs/articles/benchmarking.html).
 
-| Software                                                                            | Platform | WHO (0-5 years) (ms) | IG-21<sup>st</sup> NBS (ms) | IG-21<sup>st</sup> PNG (ms) | IG-21<sup>st</sup> Fetal (ms) |
-|-------------------------------------------------------------------------------------|----------|----------------------|-----------------------------|-----------------------------|-------------------------------|
-| [gigs](https://www.github.com/ropensci/gigs/)                                       | R        | 103                  | 84                          | 23                          | 9                             |
-| [anthro](https://cran.r-project.org/web/packages/anthro/index.html)                 | R        | 2274                 | ❌                          | ❌                          | ❌                            |
-| [AGD](https://cran.r-project.org/web/packages/AGD/index.html)                       | R        | 122                  | ❌                          | ❌                          | ❌                            |
-| [childsds](https://cran.r-project.org/web/packages/childsds/index.html)             | R        | 128                  | ❌                          | ❌                          | ❌                            |
-| [ki-tools/growthstandards](https://www.github.com/ki-tools/growthstandards/)        | R        | 92                   | 73                          | 42                          | 11                            |
-| [nutriverse/intergrowth](https://github.com/nutriverse/intergrowth/)                | R        | ❌                   | ❌                          | ❌                          | 17                            |
-| [sitar](https://cran.r-project.org/web/packages/sitar/index.html)                   | R        | 46                   | ❌                          | ❌                          | ❌                            |
-| [zscorer](https://cran.r-project.org/web/packages/zscorer/index.html)               | R        | NA                   | ❌                          | ❌                          | ❌                            |
-| [gigs](https://www.github.com/ropensci/gigs-stata/) (Stata)                         | Stata    | 348                  | 377                         | 109                         | 57                            |
-| [zanthro](https://journals.sagepub.com/doi/epdf/10.1177/1536867X1301300211) (Stata) | Stata    | 1059                 | ❌                          | ❌                          | ❌                            |
-| [gigs](https://github.com/SASPAC/gigs/) (SAS)                                       | SAS      | 181                  | 184                         | 88                          | 87                            |
+| Software | Platform | WHO (0-5 years) (ms) | IG-21<sup>st</sup> NBS (ms) | IG-21<sup>st</sup> PNG (ms) | IG-21<sup>st</sup> Fetal (ms) |
+|----|----|----|----|----|----|
+| [gigs](https://www.github.com/ropensci/gigs/) | R | 103 | 84 | 23 | 9 |
+| [anthro](https://cran.r-project.org/web/packages/anthro/index.html) | R | 2274 | ❌ | ❌ | ❌ |
+| [AGD](https://cran.r-project.org/web/packages/AGD/index.html) | R | 122 | ❌ | ❌ | ❌ |
+| [childsds](https://cran.r-project.org/web/packages/childsds/index.html) | R | 128 | ❌ | ❌ | ❌ |
+| [ki-tools/growthstandards](https://www.github.com/ki-tools/growthstandards/) | R | 92 | 73 | 42 | 11 |
+| [nutriverse/intergrowth](https://github.com/nutriverse/intergrowth/) | R | ❌ | ❌ | ❌ | 17 |
+| [sitar](https://cran.r-project.org/web/packages/sitar/index.html) | R | 46 | ❌ | ❌ | ❌ |
+| [zscorer](https://cran.r-project.org/web/packages/zscorer/index.html) | R | NA | ❌ | ❌ | ❌ |
+| [gigs](https://www.github.com/ropensci/gigs-stata/) (Stata) | Stata | 348 | 377 | 109 | 57 |
+| [zanthro](https://journals.sagepub.com/doi/epdf/10.1177/1536867X1301300211) (Stata) | Stata | 1059 | ❌ | ❌ | ❌ |
+| [gigs](https://github.com/SASPAC/gigs/) (SAS) | SAS | 181 | 184 | 88 | 87 |
 
 Note: `zscorer` is NA because we couldn’t time it for 100,000 inputs (it
 takes too long).

diff --git a/codemeta.json b/codemeta.json
@@ -14,7 +14,7 @@
     "name": "R",
     "url": "https://r-project.org"
   },
-  "runtimePlatform": "R version 4.3.3 (2024-02-29 ucrt)",
+  "runtimePlatform": "R version 4.4.1 (2024-06-14 ucrt)",
   "author": [
     {
       "@type": "Person",
@@ -294,7 +294,7 @@
     },
     "SystemRequirements": null
   },
-  "fileSize": "2268.053KB",
+  "fileSize": "2264.11KB",
   "citation": [
     {
       "@type": "SoftwareSourceCode",
@@ -318,7 +318,7 @@
       ],
       "name": "{gigs}: Assess Fetal, Newborn, and Child Growth with International Standards",
       "url": "https://github.com/ropensci/gigs/",
-      "description": "0.5.1.9000"
+      "description": "0.4.1.9002"
     }
   ],
   "releaseNotes": "https://github.com/ropensci/gigs/blob/master/NEWS.md",

diff --git a/man/figures/README-example_zp2v_curves-1.png b/man/figures/README-example_zp2v_curves-1.png