Skip to content

Commit

Permalink
Build for 2.2.
Browse files Browse the repository at this point in the history
  • Loading branch information
LS31 committed Nov 11, 2020
1 parent 2af7b66 commit 316f293
Show file tree
Hide file tree
Showing 35 changed files with 47 additions and 43 deletions.
1 change: 1 addition & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@

* Added a `NEWS.md` file to track changes to the package.
* Added assertions and testthat tests for existing functions.
* Improved support for `NA` values.
* Added new calculations: CURB-65, MAP, pulse pressure, albumin-adjusted calcium, eGFR formula.
* Updated documentation.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ Help and pull requests are more than welcome.
- *Nephrology*
- Estimate glomerular filtration rate based on creatinine clearance.

# Design philosophy
# Design ideas

**Reliable**

- *Explicit units for output*
- Numeric output of a function will have a specified unit attribute (if applicable) using the [units](https://r-quantities.github.io/units/) package.
- *Fail-fast without assumptions*
- If certain conditions are not explicitly provided, err on the side of caution (e.g. a fasting state has to be provided in order for a glucose to be considered a fasting glucose).
- If certain conditions are not explicitly provided, err on the side of caution (e.g. a fasting state has to be provided in order for a glucose to be considered a fasting glucose). If `NA` values are provided, functions will return `NA` unless otherwise specified.
- *Explicit references and caveats*
- Every function will have references and a section on caveats. (However, despite our best efforts of quality control, the functions are provided as-is, without any guarantees, and users would be wise to check the output for quality and accuracy in their use case.)

Expand All @@ -50,7 +50,7 @@ Help and pull requests are more than welcome.

# Practical notes on the use of the unit attribute

If applicable, functions will return numeric values with a unit attribute using the [units](https://r-quantities.github.io/units/) package. This is to be as explicit as possible to the end user about the generated data. However, the unit attributes may sometimes be bothersome. Use `units::drop_units(x)` to drop the unit attribute. Load the ggforce package (an extension of ggplot) if you want to incorporate the unit attribute in the scales of a ggplot figure (see [ggforce reference page Position scales for units data](https://ggforce.data-imaginist.com/reference/scale_unit.html)).
If applicable, functions will return numeric values with a unit attribute using the [units](https://r-quantities.github.io/units/) package. The idea is to be as explicit as possible to the end user about the generated data. However, the unit attributes may sometimes be bothersome. Use `units::drop_units(x)` to drop the unit attribute. Load the ggforce package (an extension of ggplot) if you want to incorporate the unit attribute in the scales of a ggplot figure (see [ggforce reference page Position scales for units data](https://ggforce.data-imaginist.com/reference/scale_unit.html)).

# How to install

Expand All @@ -66,7 +66,7 @@ remotes::install_github("ls31/clinicalr")
remotes::install_github("lc31/clinicalr")
```

# To do
# Ideas for the future
* effective osmolality?
* anion gap?
* total body water?
Expand All @@ -76,4 +76,5 @@ remotes::install_github("lc31/clinicalr")
* A-a gradient?
* creatinine clearance (using urine)?
* Framingham?
* assertion tests
* full SOFA score?
* Calvert formula (AUC) for carboplatin?
15 changes: 8 additions & 7 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/news/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ pandoc: 2.7.3
pkgdown: 1.6.1
pkgdown_sha: ~
articles: {}
last_built: 2020-11-04T21:04Z
last_built: 2020-11-11T17:03Z
urls:
reference: https://ls31.github.io/clinicalr//reference
article: https://ls31.github.io/clinicalr//articles
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/adjust_calcium_for_albumin.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/adjust_sodium_for_glucose.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/calculate_bmi.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/calculate_pulse_pressure.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/calculate_qtc.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/estimate_bsa.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/estimate_gfr_ckdepi.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/estimate_gfr_cockcroft.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/estimate_gfr_mdrd.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/estimate_gfr_schwartz.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/estimate_ibw.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/estimate_map.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/has_metabolic_syndrome_atpiii.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/score_curb65.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/score_qsofa.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/adjust_calcium_for_albumin.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/adjust_sodium_for_glucose.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/calculate_bmi.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/calculate_pulse_pressure.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/calculate_qtc.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/estimate_bsa.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/estimate_gfr_ckdepi.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/estimate_gfr_cockcroft.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/estimate_gfr_mdrd.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/estimate_gfr_schwartz.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/estimate_ibw.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/estimate_map.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/has_metabolic_syndrome_atpiii.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/score_curb65.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/score_qsofa.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 316f293

Please sign in to comment.