From 6e3d9caf8fbe1effa00b1c80e37068f538f822df Mon Sep 17 00:00:00 2001 From: Ross Farrugia <82581364+rossfarrugia@users.noreply.github.com> Date: Mon, 9 Sep 2024 15:08:50 +0100 Subject: [PATCH] [skip vbump] closes #10 add badges and CRAN installation instructions (#93) * #10 add badges and CRAN installation instructions * #10 news * #10 version number * #10 Update WORDLIST --- DESCRIPTION | 2 +- NEWS.md | 14 ++++++++++++++ README.md | 14 ++++++++++++++ inst/WORDLIST | 1 + 4 files changed, 30 insertions(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 5a7e4c0c..dbcd7f45 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Type: Package Package: admiralpeds Title: Pediatrics Extension Package for ADaM in 'R' Asset Library -Version: 0.1.0 +Version: 0.1.0.9000 Authors@R: c( person("Fanny", "Gautier", , "fanny.gautier@cytel.com", role = c("aut", "cre")), person("Ross", "Farrugia", role = "aut"), diff --git a/NEWS.md b/NEWS.md index 86fcc29c..3b96a965 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,17 @@ +# admiralpeds 0.1.0.9000 + +## New Features + +## Updates of Existing Functions + +## Breaking Changes + +## Documentation + +- Added CRAN installation instructions to README (#10). + +## Various + # admiralpeds 0.1.0 - Initial package release focused mainly on Anthropometric indicators (i.e. child growth diff --git a/README.md b/README.md index 90c152e8..d345675c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ # admiralpeds + + +[](https://pharmaverse.org) +[![CRAN status](https://www.r-pkg.org/badges/version/admiralpeds)](https://CRAN.R-project.org/package=admiralpeds) +[![Test Coverage](https://raw.githubusercontent.com/pharmaverse/admiralpeds/badges/main/test-coverage.svg)](https://github.com/pharmaverse/admiral/actions/workflows/code-coverage.yml) + + + Pediatrics extension package for ADaM in R Asset Library `{admiral}` ## Purpose @@ -9,6 +17,12 @@ to develop specifics for pediatric clinical trials. ## Installation +The package is available from CRAN and can be installed with: + +```r +install.packages("admiralpeds") +``` + To install the development version of the package from GitHub run: ```r diff --git a/inst/WORDLIST b/inst/WORDLIST index 10068d10..6d51ed27 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -17,6 +17,7 @@ DM Hoffmann LMS LOCF +README SDTM SDs anthropometric