diff --git a/.github/workflows/common.yml b/.github/workflows/common.yml index e280e090..26caf981 100644 --- a/.github/workflows/common.yml +++ b/.github/workflows/common.yml @@ -61,13 +61,6 @@ jobs: needs: get_r_version with: r-version: "${{ needs.get_r_version.outputs.r-version }}" - readme: - name: Render README - uses: pharmaverse/admiralci/.github/workflows/readme-render.yml@main - if: github.event_name == 'push' - needs: get_r_version - with: - r-version: "${{ needs.get_r_version.outputs.r-version }}" validation: name: Validation uses: pharmaverse/admiralci/.github/workflows/r-pkg-validation.yml@main diff --git a/DESCRIPTION b/DESCRIPTION index 980c7646..8d3a85b4 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: admiralonco Type: Package Title: Oncology Extension Package for ADaM in 'R' Asset Library -Version: 0.5.0.9001 +Version: 1.0.0 Authors@R: c( person("Stefan", "Bundfuss", email = "stefan.bundfuss@roche.com", role = c("aut", "cre")), person("Ross", "Farrugia", role = "aut"), @@ -12,6 +12,8 @@ Authors@R: c( person("Stephen", "Gormley", role = "aut"), person("Hinal", "Patel", role = "aut"), person("Vinh", "Nguyen", role = "aut"), + person("Olga", "Starostecka", role = "ctb"), + person("Uwe", "Bader", role = "ctb"), person("Karl", "Kennedy", role = "ctb"), person("Edoardo", "Mancini", role = "ctb"), person("Matt", "Marino", role = "ctb"), @@ -45,8 +47,8 @@ Roxygen: list(markdown = TRUE) RoxygenNote: 7.2.3 Depends: R (>= 3.5) Imports: - admiral (>= 0.12.0), - admiraldev (>= 0.4.0), + admiral (>= 1.0.0), + admiraldev (>= 1.0.0), dplyr (>= 0.8.4), lifecycle (>= 0.1.0), lubridate (>= 1.7.4), diff --git a/NEWS.md b/NEWS.md index 4228de27..0022886a 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# admiralonco (development version) +# admiralonco 1.0.0 ## Updates of Existing Functions diff --git a/README.Rmd b/README.Rmd deleted file mode 100644 index 59c3ecf3..00000000 --- a/README.Rmd +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Oncology extension package for ADaM in R Asset Library" -output: md_document -date: '2022-10-04' ---- - - - - -# admiralonco - - -[](https://pharmaverse.org) -[![CRAN status](https://www.r-pkg.org/badges/version/admiralonco)](https://CRAN.R-project.org/package=admiralonco) - - -Oncology extension package for ADaM in R Asset Library `{admiral}` - -## Purpose - -To provide a complementary (to `{admiral}`) toolbox that enables users to develop oncology disease area specifics. - -## Installation - -The package is available from CRAN and can be installed by running `install.packages("admiralonco")`. - -To install the latest development version of the package directly from GitHub use the following code: - -```r -if (!requireNamespace("remotes", quietly = TRUE)) { - install.packages("remotes") -} - -remotes::install_github("pharmaverse/admiraldev", ref = "devel") # This is a required dependency of {admiralonco} -remotes::install_github("pharmaverse/admiral", ref = "devel") # This is a required dependency of {admiralonco} -remotes::install_github("pharmaverse/admiralonco", ref = "devel") -``` - -### Dependencies - -The latest version of the package works with the latest versions of the packages -stated in `DESCRIPTION`. - -If a previous version of the package should be used, it is recommended to use -latest version of the dependencies at the point of time when the previous -version of {admiralonco} was released. For example, admiralonco 0.3.0 was -released on 2023-03-14. I.e., it will work with the latest version of packages -available at that date, e.g., admiral 0.10. - -## Scope - -* Build a toolbox of re-usable functions and utilities to create oncology-specific ADaM datasets in R in a modular manner. -* All functions are created based upon the ADaM Implementation Guide and aim to facilitate the programming of ADaM dataset standards. -* Initially the package will focus on the most common efficacy endpoint needs for solid tumor (using RECIST v1.1 response criteria), -but over time we will look to add extra areas such as: endpoints for targeted indications, baseline disease characteristics, common -sensitivity analyses and questionnaires. - -## Expectations - -`{admiralonco}` is expected to complement `{admiral}` and provide functions to help with the creation of the efficacy endpoints required for oncology ADaMs. - -## References and Documentation - -* Please refer to the [References and Documentation](https://pharmaverse.github.io/admiral/index.html#references-and-documentation) - -## R Versions - -Here's a summary of our strategy for this package related to R versions: - -* R versions for developers and users will follow the same as `{admiral}` core package. -* For development the `devel` branch of `{admiral}` core is used as a dependency. For releasing a new `{admiralonco}` version it must run using the latest released `{admiral}` core version, i.e., `main` branch of `{admiral}` core. - -## Contact - -We use the following for support and communications between user and developer community: - -* [Slack](https://app.slack.com/client/T028PB489D3/C02M8KN8269) - for informal discussions, Q&A and building our user community. If you don't have access, use this [link](https://join.slack.com/t/pharmaverse/shared_invite/zt-yv5atkr4-Np2ytJ6W_QKz_4Olo7Jo9A) to join the pharmaverse Slack workspace -* [GitHub Issues](https://github.com/pharmaverse/admiralonco/issues) - for direct feedback, enhancement requests or raising bugs diff --git a/README.md b/README.md index 027bd8a2..f15c195e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,3 @@ - - - # admiralonco @@ -19,19 +16,24 @@ to develop oncology disease area specifics. ## Installation -The package is available from CRAN and can be installed by running -`install.packages("admiralonco")`. +The package is available from CRAN and can be installed with: + +```r +install.packages("admiralonco") +``` To install the latest development version of the package directly from GitHub use the following code: - if (!requireNamespace("remotes", quietly = TRUE)) { - install.packages("remotes") - } +```r +if (!requireNamespace("remotes", quietly = TRUE)) { + install.packages("remotes") +} - remotes::install_github("pharmaverse/admiraldev", ref = "devel") # This is a required dependency of {admiralonco} - remotes::install_github("pharmaverse/admiral", ref = "devel") # This is a required dependency of {admiralonco} - remotes::install_github("pharmaverse/admiralonco", ref = "devel") +remotes::install_github("pharmaverse/admiraldev") # This is a required dependency of {admiralonco} +remotes::install_github("pharmaverse/admiral") # This is a required dependency of {admiralonco} +remotes::install_github("pharmaverse/admiralonco") +``` ### Dependencies @@ -73,10 +75,9 @@ Here’s a summary of our strategy for this package related to R versions: - R versions for developers and users will follow the same as `{admiral}` core package. -- For development the `devel` branch of `{admiral}` core is used as a +- For development the `main` branch of `{admiral}` core is used as a dependency. For releasing a new `{admiralonco}` version it must run - using the latest released `{admiral}` core version, i.e., `main` - branch of `{admiral}` core. + using the latest released `{admiral}` core version. ## Contact diff --git a/man/admiralonco-package.Rd b/man/admiralonco-package.Rd index e80bfadb..403c2617 100644 --- a/man/admiralonco-package.Rd +++ b/man/admiralonco-package.Rd @@ -36,6 +36,8 @@ Authors: Other contributors: \itemize{ + \item Olga Starostecka [contributor] + \item Uwe Bader [contributor] \item Karl Kennedy [contributor] \item Edoardo Mancini [contributor] \item Matt Marino [contributor]