Skip to content

Commit f38c795

Browse files
committed
docs: update README with proper benchmarking link and NEWS.md
1 parent 17c3a95 commit f38c795

4 files changed

Lines changed: 63 additions & 53 deletions

File tree

NEWS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# gigs (development version)
22

33
- Documentation updates due to JOSS publication.
4-
- Other docs updates to fix minor errors.
4+
- Other docs updates to fix minor errors with R CMD check.
55

66
# gigs 0.5.2
77

README.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ We have benchmarked these implementations against each other for conversion of v
439439
`r intergrowth21st` standards. The table below shows the relative speed of each
440440
software package when processing 100,000 inputs. The code used to generate these
441441
timings can be seen online in the **gigs** benchmarking
442-
[article](https://ropensci.github.io/gigs/articles/benchmarking.html).
442+
[article](https://docs.ropensci.org/gigs/articles/benchmarking.html).
443443

444444
| Software | Platform | WHO (0-5 years) (ms) | `r ig21st` NBS (ms) | `r ig21st` PNG (ms) | `r ig21st` Fetal (ms) |
445445
|-----------------|----------|-------------------------------------------|----------------------------------------|----------------------------------------|-----------------------------------------|

README.md

Lines changed: 61 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,9 @@ and INTERGROWTH-21<sup>st</sup> project:
221221
- `ig_nbs` - INTERGROWTH-21<sup>st</sup> Newborn Size standards
222222
(including very preterm)
223223
<details>
224+
224225
<summary>
226+
225227
Component standards
226228
</summary>
227229

@@ -239,7 +241,9 @@ and INTERGROWTH-21<sup>st</sup> project:
239241
- `ig_nbs_ext` - Extended INTERGROWTH-21<sup>st</sup> Newborn Size
240242
standards (including very preterm)
241243
<details>
244+
242245
<summary>
246+
243247
Component standards
244248
</summary>
245249

@@ -253,7 +257,9 @@ and INTERGROWTH-21<sup>st</sup> project:
253257
- `ig_png` - INTERGROWTH-21<sup>st</sup> Postnatal Growth of Preterm
254258
Infants standards
255259
<details>
260+
256261
<summary>
262+
257263
Component standards
258264
</summary>
259265

@@ -267,38 +273,42 @@ and INTERGROWTH-21<sup>st</sup> project:
267273
</details>
268274
- `ig_fet` - INTERGROWTH-21<sup>st</sup> Fetal standards
269275
<details>
276+
270277
<summary>
278+
271279
Component standards
272280
</summary>
273281

274-
| Acronym | Description | Unit | `x` range |
275-
|-----------|--------------------------------------------------------------|------|-----------------|
276-
| `hcfga` | head circumference-for-GA | mm | 98 to 280 days |
277-
| `bpdfga` | biparietal diameter-for-GA | mm | 98 to 280 days |
278-
| `acfga` | abdominal circumference-for-GA | mm | 98 to 280 days |
279-
| `flfga` | femur length-for-GA | mm | 98 to 280 days |
280-
| `ofdfga` | occipito-frontal diameter for-GA | mm | 98 to 280 days |
281-
| `efwfga` | estimated fetal weight-for-GA | g | 154 to 280 days |
282-
| `sfhfga` | symphisis-fundal height-for-GA | mm | 112 to 294 days |
283-
| `crlfga` | crown-rump length-for-GA | mm | 58 to 105 days |
284-
| `gafcrl` | GA-for-crown-rump length | days | 15 to 95 mm |
285-
| `gwgfga` | gestational weight gain-for-GA | kg | 98 to 280 days |
286-
| `pifga` | pulsatility index-for-GA | | 168 to 280 days |
287-
| `rifga` | resistance index-for-GA | | 168 to 280 days |
288-
| `sdrfga` | systolic/diastolic ratio-for-GA | | 168 to 280 days |
289-
| `tcdfga` | transcerebellar diameter-for-GA | mm | 98 to 280 days |
290-
| `tcdfga` | GA-for-transcerebellar diameter | mm | 98 to 280 days |
291-
| `poffga` | parietal-occipital fissure-for-GA | mm | 105 to 252 days |
292-
| `sffga` | Sylvian fissue-for-GA | mm | 105 to 252 days |
293-
| `avfga` | anterior horn of the lateral ventricle-for-GA | mm | 105 to 252 days |
294-
| `pvfga` | atrium of the posterior horn of the lateral ventricle-for-GA | mm | 105 to 252 days |
295-
| `cmfga` | cisterna magna-for-GA | mm | 105 to 252 days |
296-
| `hefwfga` | Hadlock estimated fetal weight-for-GA | g | 126 to 287 days |
282+
| Acronym | Description | Unit | `x` range |
283+
|----|----|----|----|
284+
| `hcfga` | head circumference-for-GA | mm | 98 to 280 days |
285+
| `bpdfga` | biparietal diameter-for-GA | mm | 98 to 280 days |
286+
| `acfga` | abdominal circumference-for-GA | mm | 98 to 280 days |
287+
| `flfga` | femur length-for-GA | mm | 98 to 280 days |
288+
| `ofdfga` | occipito-frontal diameter for-GA | mm | 98 to 280 days |
289+
| `efwfga` | estimated fetal weight-for-GA | g | 154 to 280 days |
290+
| `sfhfga` | symphisis-fundal height-for-GA | mm | 112 to 294 days |
291+
| `crlfga` | crown-rump length-for-GA | mm | 58 to 105 days |
292+
| `gafcrl` | GA-for-crown-rump length | days | 15 to 95 mm |
293+
| `gwgfga` | gestational weight gain-for-GA | kg | 98 to 280 days |
294+
| `pifga` | pulsatility index-for-GA | | 168 to 280 days |
295+
| `rifga` | resistance index-for-GA | | 168 to 280 days |
296+
| `sdrfga` | systolic/diastolic ratio-for-GA | | 168 to 280 days |
297+
| `tcdfga` | transcerebellar diameter-for-GA | mm | 98 to 280 days |
298+
| `tcdfga` | GA-for-transcerebellar diameter | mm | 98 to 280 days |
299+
| `poffga` | parietal-occipital fissure-for-GA | mm | 105 to 252 days |
300+
| `sffga` | Sylvian fissue-for-GA | mm | 105 to 252 days |
301+
| `avfga` | anterior horn of the lateral ventricle-for-GA | mm | 105 to 252 days |
302+
| `pvfga` | atrium of the posterior horn of the lateral ventricle-for-GA | mm | 105 to 252 days |
303+
| `cmfga` | cisterna magna-for-GA | mm | 105 to 252 days |
304+
| `hefwfga` | Hadlock estimated fetal weight-for-GA | g | 126 to 287 days |
297305

298306
</details>
299307
- `who_gs` - WHO Child Growth Standards for term infants
300308
<details>
309+
301310
<summary>
311+
302312
Component standards
303313
</summary>
304314

@@ -456,41 +466,41 @@ package, a red cross (❌) indicates that these standards are completely
456466
missing, and a warning sign (⚠️) indicates that some of these standards
457467
are implemented but not others.
458468

459-
| 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 |
460-
|-------------------------------------------------------------------------------------|----------|-----------------|------------------------|------------------------|--------------------------|----------------------------|
461-
| [gigs](https://www.github.com/ropensci/gigs/) | R | | | | | Values ↔ z-scores/centiles |
462-
| [anthro](https://cran.r-project.org/web/packages/anthro/index.html) | R | | | | | Values → z-scores |
463-
| [AGD](https://cran.r-project.org/web/packages/AGD/index.html) | R | | | | | Values ↔ z-scores |
464-
| [childsds](https://cran.r-project.org/web/packages/childsds/index.html) | R | | | | | Values → z-scores/centiles |
465-
| [ki-tools/growthstandards](https://www.github.com/ki-tools/growthstandards/) | R | | | ⚠️ | ⚠️ | Values ↔ z-scores/centiles |
466-
| [nutriverse/intergrowth](https://github.com/nutriverse/intergrowth/) | R | | | | ⚠️ | Values → z-scores/centiles |
467-
| [sitar](https://cran.r-project.org/web/packages/sitar/index.html) | R | | | | | Values ↔ z-scores/centiles |
468-
| [zscorer](https://cran.r-project.org/web/packages/zscorer/index.html) | R | | | | | Values → z-scores/centiles |
469-
| [gigs](https://www.github.com/ropensci/gigs-stata/) (Stata) | Stata | | | | | Values ↔ z-scores/centiles |
470-
| [zanthro](https://journals.sagepub.com/doi/epdf/10.1177/1536867X1301300211) (Stata) | Stata | | | | | Values → z-scores/centiles |
471-
| [gigs](https://github.com/SASPAC/gigs/) (SAS) | SAS | | | | | Values ↔ z-scores/centiles |
469+
| 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 |
470+
|----|----|----|----|----|----|----|
471+
| [gigs](https://www.github.com/ropensci/gigs/) | R ||||| Values ↔ z-scores/centiles |
472+
| [anthro](https://cran.r-project.org/web/packages/anthro/index.html) | R ||||| Values → z-scores |
473+
| [AGD](https://cran.r-project.org/web/packages/AGD/index.html) | R ||||| Values ↔ z-scores |
474+
| [childsds](https://cran.r-project.org/web/packages/childsds/index.html) | R ||||| Values → z-scores/centiles |
475+
| [ki-tools/growthstandards](https://www.github.com/ki-tools/growthstandards/) | R ||| ⚠️ | ⚠️ | Values ↔ z-scores/centiles |
476+
| [nutriverse/intergrowth](https://github.com/nutriverse/intergrowth/) | R |||| ⚠️ | Values → z-scores/centiles |
477+
| [sitar](https://cran.r-project.org/web/packages/sitar/index.html) | R ||||| Values ↔ z-scores/centiles |
478+
| [zscorer](https://cran.r-project.org/web/packages/zscorer/index.html) | R ||||| Values → z-scores/centiles |
479+
| [gigs](https://www.github.com/ropensci/gigs-stata/) (Stata) | Stata ||||| Values ↔ z-scores/centiles |
480+
| [zanthro](https://journals.sagepub.com/doi/epdf/10.1177/1536867X1301300211) (Stata) | Stata ||||| Values → z-scores/centiles |
481+
| [gigs](https://github.com/SASPAC/gigs/) (SAS) | SAS ||||| Values ↔ z-scores/centiles |
472482

473483
We have benchmarked these implementations against each other for
474484
conversion of values to z-scores in the WHO Child Growth Standards and
475485
different sets of INTERGROWTH-21<sup>st</sup> standards. The table below
476486
shows the relative speed of each software package when processing
477487
100,000 inputs. The code used to generate these timings can be seen
478488
online in the **gigs** benchmarking
479-
[article](https://ropensci.github.io/gigs/articles/benchmarking.html).
480-
481-
| 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) |
482-
|-------------------------------------------------------------------------------------|----------|----------------------|-----------------------------|-----------------------------|-------------------------------|
483-
| [gigs](https://www.github.com/ropensci/gigs/) | R | 101 | 79 | 21 | 11 |
484-
| [anthro](https://cran.r-project.org/web/packages/anthro/index.html) | R | 2178 | | | |
485-
| [AGD](https://cran.r-project.org/web/packages/AGD/index.html) | R | 113 | | | |
486-
| [childsds](https://cran.r-project.org/web/packages/childsds/index.html) | R | 125 | | | |
487-
| [ki-tools/growthstandards](https://www.github.com/ki-tools/growthstandards/) | R | 89 | 70 | 41 | 12 |
488-
| [nutriverse/intergrowth](https://github.com/nutriverse/intergrowth/) | R | | | | 17 |
489-
| [sitar](https://cran.r-project.org/web/packages/sitar/index.html) | R | 46 | | | |
490-
| [zscorer](https://cran.r-project.org/web/packages/zscorer/index.html) | R | NA | | | |
491-
| [gigs](https://www.github.com/ropensci/gigs-stata/) (Stata) | Stata | 351 | 382 | 108 | 58 |
492-
| [zanthro](https://journals.sagepub.com/doi/epdf/10.1177/1536867X1301300211) (Stata) | Stata | 1063 | | | |
493-
| [gigs](https://github.com/SASPAC/gigs/) (SAS) | SAS | 186 | 187 | 89 | 90 |
489+
[article](https://docs.ropensci.org/gigs/articles/benchmarking.html).
490+
491+
| 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) |
492+
|----|----|----|----|----|----|
493+
| [gigs](https://www.github.com/ropensci/gigs/) | R | 101 | 79 | 21 | 11 |
494+
| [anthro](https://cran.r-project.org/web/packages/anthro/index.html) | R | 2178 ||||
495+
| [AGD](https://cran.r-project.org/web/packages/AGD/index.html) | R | 113 ||||
496+
| [childsds](https://cran.r-project.org/web/packages/childsds/index.html) | R | 125 ||||
497+
| [ki-tools/growthstandards](https://www.github.com/ki-tools/growthstandards/) | R | 89 | 70 | 41 | 12 |
498+
| [nutriverse/intergrowth](https://github.com/nutriverse/intergrowth/) | R |||| 17 |
499+
| [sitar](https://cran.r-project.org/web/packages/sitar/index.html) | R | 46 ||||
500+
| [zscorer](https://cran.r-project.org/web/packages/zscorer/index.html) | R | NA ||||
501+
| [gigs](https://www.github.com/ropensci/gigs-stata/) (Stata) | Stata | 351 | 382 | 108 | 58 |
502+
| [zanthro](https://journals.sagepub.com/doi/epdf/10.1177/1536867X1301300211) (Stata) | Stata | 1063 ||||
503+
| [gigs](https://github.com/SASPAC/gigs/) (SAS) | SAS | 186 | 187 | 89 | 90 |
494504

495505
Note: `zscorer` is NA because we couldn’t time it for 100,000 inputs (it
496506
takes too long).
6.79 KB
Loading

0 commit comments

Comments
 (0)