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

Improvements to lifting 11k #91

Merged
merged 7 commits into from
Mar 8, 2024

Conversation

stufield
Copy link
Contributor

@stufield stufield commented Mar 4, 2024

Overview of PR

  • A comprehensive overhaul of the lifting code and inclusion of the 11k bridging functionality

Main Changes

  • Bump version to 9001 in case users want to download the dev version

  • Clean up lifting documentation

  • Add lifting accessor function for Lin's CCC

    • new function getLiftCCC()
    • accesses the lifting correlations between
      SomaScan versions for each analyte
    • fixed small bug with SomaReadr reference
      in params.R
  • Restructure of lift_adat() functionality

    • lift_adat() now takes a bridge = argument,
      replacing the anno.tbl = argument. Lifting
      is now performed internally for a better (and safer)
      user experience, without the necessity of an
      external annotations file. Much simpler user experience.
    • the majority of this refactoring was internal
      and the user should not experience a major
      disruption to the API.
    • new internal objects lift_master and lref
      as sources of internal scaling factors (lifting)
    • new function is_lifted()
  • Update read_annotations() with 11k content

  • Update transform() and scaleAnalytes()

    • scaleAnalytes() now skips missing references
    • transform() now has edge case protection drop = FALSE in
      case of a single analyte ADAT

Internal Use Only

Change Type

Please check the relevant box(es):

- scaleAnalytes() now skips missing references
@stufield stufield requested a review from scheidec March 4, 2024 19:20
@stufield stufield force-pushed the improvements-to-lifting-11k branch from 5c49e3f to 1d72db6 Compare March 4, 2024 21:15
@codecov-commenter
Copy link

codecov-commenter commented Mar 4, 2024

Codecov Report

Attention: Patch coverage is 80.82192% with 14 lines in your changes are missing coverage. Please review.

Project coverage is 75.23%. Comparing base (c6e2233) to head (8e9e1d3).
Report is 9 commits behind head on main.

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

Files Patch % Lines
R/read-annotations.R 44.44% 5 Missing ⚠️
R/utils-lift.R 81.81% 4 Missing ⚠️
R/getSomaScanLiftCCC.R 0.00% 3 Missing ⚠️
R/lift-adat.R 95.00% 1 Missing ⚠️
R/s3-transform.R 50.00% 1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #91      +/-   ##
==========================================
+ Coverage   73.88%   75.23%   +1.35%     
==========================================
  Files          39       41       +2     
  Lines        1455     1474      +19     
==========================================
+ Hits         1075     1109      +34     
+ Misses        380      365      -15     

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

@stufield stufield force-pushed the improvements-to-lifting-11k branch from 1d72db6 to 1000a5a Compare March 5, 2024 01:07
- `lift_adat()` now takes a `bridge =` argument,
  replacing the `anno.tbl =` argument. Lifting
  is now performed internally for a better (and safer)
  user experience, without the necessity of an
  external annotations file. Much simpler user experience.
- the majority of this refactoring was internal
  and the user should not experience a major
  disruption to the API.
- new internal objects `lift_master` and `lref`
  as sources of internal scaling factors (lifting)
- new function `is_lifted()`
- closes SomaLogic#81, closes SomaLogic#78
- new function getLiftCCC()
- accesses the lifting correlations between
  SomaScan versions for each analyte
- fixed small bug with SomaReadr reference
  in params.R
- closes SomaLogic#88
@stufield stufield force-pushed the improvements-to-lifting-11k branch from 1000a5a to d7401d1 Compare March 5, 2024 01:20
@stufield stufield merged commit 7d95b3f into SomaLogic:main Mar 8, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants