Skip to content

Commit

Permalink
Closes # 48 Update NEWS.md ahead of first release (#55)
Browse files Browse the repository at this point in the history
* # 48 updated discription of initial package release in NEWS.md.

* # 48 Added subsections of "New features" and "Documentation".

* # 48 Updated WORDLIST to pass spellcheck.

* #48 Pulled from origin/main to resolve conflict.

* #48 updated subsection from "New Features" to "Functions".

* #48 updated wordings.

* #48 deleted example

* #48 Added a period.

Co-authored-by: Anders Askeland <[email protected]>

* #48 updated description.

---------

Co-authored-by: Anders Askeland <[email protected]>
  • Loading branch information
kiwi5104679 and AndersAskeland authored Dec 18, 2024
1 parent f94f7c9 commit 81497de
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Type: Package
Package: admiralmetabolic
Title: Metabolism Extension Package for ADaM in 'R' Asset Library
Version: 0.0.0
Version: 0.1.0
Authors@R: c(
person("Edoardo", "Mancini", , "[email protected]", role = c("aut", "cre")),
person("Anders", "Askeland", , "[email protected]", role = "aut")
Expand Down
16 changes: 11 additions & 5 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# admiralmetabolic 0.1.0

- Initial package release focused on `<<ADD INITIAL SCOPE>>`
- Initial package release mainly focused on obesity therapeutic area.

Note that after first release you should then start maintaining this `NEWS.md` file for every user-facing update.
You should categorize the updates under title sections for New Features, Updates of Existing Functions,
Breaking Changes, Documentation, Various.
Each update should also reference the original issue by adding at the end: (#ISSUE-NUMBER)
## Functions

- The function `derive_param_waisthip()` for deriving Waist to Hip Ratio. (#33 & #52)
- The function `derive_param_waisthgt()` for deriving Waist to Height Ratio. (#33 & #52)

## Documentation

- Vignette "Creating a Metabolic ADVS ADaM". (#28)
- Vignette "Creating a Control of Eating Questionnaire ADaM". (#53)
- ADVS template scripts `ad_advs.R` which creates a Vital Sign Analysis Dataset with metabolic specific derivations. (#35)
3 changes: 3 additions & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,6 @@ Savoury
subscale
subscales
Subscales
param
waisthgt
waisthip

0 comments on commit 81497de

Please sign in to comment.