Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gigs 0.3.0 #18

Merged
merged 27 commits into from
Nov 17, 2023
Merged

gigs 0.3.0 #18

merged 27 commits into from
Nov 17, 2023

Conversation

simpar1471
Copy link
Member

What's new

BREAKING CHANGES:

  • Replaced gest_age parameter with gest_days in all circumstances,
    including ig_nbs growth curve/coefficient tables.
  • Replaced percentile with centile in function names and documentation.
    Argument names left unchanged, so centiles are still passed into functions
    as p.
  • classify_wasting() now takes in gestational age/age data, and uses this to
    apply the INTERGROWTH-21st Postnatal Growth standard for
    weight-for-length where appropriate.

NEW FEATURES:

  • Added classify_svn() function, which classifies newborns into the
    categories used in the Lancet's 2023 Small Vulnerable Newborn (SVN) Series.
    This change closes Add classify_svn() function #17 .

INTERNAL/DOCS CHANGES:

  • Updated coefficient retrieval functions to run ~ 2 times as fast as in
    version 0.2.3.
  • Added arugment type checking functions to conversion functions, along with
    additional unit tests to make sure they work.
  • Extensive changes to documentation structure. These changes appear
    internally, where the roxygen documentation uses more
    @inherit/@inheritParams tags.
  • Added vignette displaying performance differences between gigs and other,
    similar R packages, as well as Stata implementations.

simpar1471 and others added 20 commits October 16, 2023 15:48
…sts to reflect change. Added codemeta.json for SEO + possible rOpenSci review.
…n docs for details.

DOCS: Documentation streamlining + updating in classification.R.
…`stop_if_wrong_type()` function.

DOCS: More inheritance of parameters, notes and references. Better documentation of internal functions.
…`stop_if_wrong_type()` function.

DOCS: More inheritance of parameters, notes and references. Better documentation of internal functions.
…ons. (2) Aligned internal logic with Stata package (see diff for details). (3) Added `outlier` argument to classification functions for stunting/wasting/weight-for-age. (4) Stratified out levels in `classify_svn()` output.
…ding in function calls.

docs: Updated docs accordingly.
@simpar1471 simpar1471 added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 17, 2023
@simpar1471 simpar1471 self-assigned this Nov 17, 2023
Copy link

codecov bot commented Nov 17, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6655157) 100.00% compared to head (ea514b4) 100.00%.
Report is 29 commits behind head on master.

❗ Current head ea514b4 differs from pull request most recent head a0edaaf. Consider uploading reports for the commit a0edaaf to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##            master       #18   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            7         8    +1     
  Lines          689       689           
=========================================
  Hits           689       689           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Updated `pkgdown.yaml` to add extra packages from `benchmarking.Rmd`. `benchmarking.Rmd` now uses saved objects in benchmarking.rda to prevent need to install extra packages.
Updated `pkgdown.yaml` with ggsci pkg.
Removed kableextra functions.
@simpar1471 simpar1471 merged commit e297c7c into master Nov 17, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add classify_svn() function
1 participant